man/bjavaloader.1

   1 .\"                                      Hey, EMACS: -*- nroff -*-
   2 .\" First parameter, NAME, should be all caps
   3 .\" Second parameter, SECTION, should be 1-8, maybe w/ subsection
   4 .\" other parameters are allowed: see man(7), man(1)
   5 .TH BJAVALOADER 1 "September 11, 2010"
   6 .\" Please adjust this date whenever revising the manpage.
   7 .\"
   8 .\" Some roff macros, for reference:
   9 .\" .nh        disable hyphenation
  10 .\" .hy        enable hyphenation
  11 .\" .ad l      left justify
  12 .\" .ad b      justify to both left and right margins
  13 .\" .nf        disable filling
  14 .\" .fi        enable filling
  15 .\" .br        insert line break
  16 .\" .sp <n>    insert n+1 empty lines
  17 .\" for manpage-specific macros, see man(7)
  18 .SH NAME
  19 .B bjavaloader
  20 \- Barry Project's program to manage BlackBerry applications
  21 .SH SYNOPSIS
  22 .B bjavaloader [\-h][\-p pin][\-P pass][\-v]
  23 .TP
  24 .B bjavaloader dir [\-s]
  25 .TP
  26 .B bjavaloader deviceinfo
  27 .TP
  28 .B bjavaloader load <.codfile>
  29 .TP
  30 .B bjavaloader save [\-A] <module_name>
  31 .TP
  32 .B bjavaloader wipe [\-a | \-i]
  33 .TP
  34 .B bjavaloader erase [\-f] <module_name>
  35 .TP
  36 .B bjavaloader eventlog
  37 .TP
  38 .B bjavaloader cleareventlog
  39 .TP
  40 .B bjavaloader logstacktraces
  41 .TP
  42 .B bjavaloader screenshot <.bmp file>
  43 .TP
  44 .B bjavaloader settime [yyyy\-mm\-dd HH:MM:SS]
  45 .SH DESCRIPTION
  46 .PP
  47 .B bjavaloader
  48 is a tool for loading, listing, and deleting applications on a BlackBerry
  49 device.  It has a few other features as well, not pertaining to application
  50 management.  The command syntax is intentionally similar to the Windows
  51 program 'javaloader.exe' provided by Research In Motion, in order
  52 to make it easy to use the same build scripts on Linux and Windows.
  53 .SH OPTIONS
  54 .TP
  55 .B \-A
  56 Used with the 'save' command to save all available modules.
  57 .TP
  58 .B \-a
  59 Used with the 'wipe' command to only wipe the applications.
  60 .TP
  61 .B \-i
  62 Used with the 'wipe' command to only wipe the filesystem.
  63 .TP
  64 .B \-f
  65 Used with the 'erase' command to force the erasure of an application
  66 that is currently in use in the device.  Experimental.
  67 .TP
  68 .B \-h
  69 Display a command help summary.
  70 .TP
  71 .B \-s
  72 When using the 'dir' command, list the submodules as well.
  73 .TP
  74 .B \-p pin
  75 Specifies the PIN number of the device with which you wish to communicate,
  76 when multiple devices are connected.
  77 .TP
  78 .B \-P password
  79 A simplistic method to specify the device password.
  80 .TP
  81 .B \-v
  82 Verbose debug output.  This enables dumping of USB bus scanning, as
  83 well as the protocol packets used during communication.
  84
  85 .SH COMMANDS
  86 .TP
  87 .B dir [\-s]
  88 Fetch a list of all applications and display them on stdout.  When used with
  89 the \-s option, submodules are included, and can take a long time to display.
  90 .TP
  91 .B deviceinfo
  92 Provides information on the handheld.
  93 .TP
  94 .B load <.cod filename> ...
  95 Loads one or more COD application files into the device.
  96 .TP
  97 .B save [\-A] <module name> ...
  98 Retrieves modules from the handheld and writes them to .cod files with the
  99 same name as the module.  Note that this will overwrite any existing .cod
 100 file in the current directory.  If the \-A option is specified, a dir will
 101 be done internally, and all available modules will be saved.
 102 .TP
 103 .B wipe [\-a | \-i]
 104 Wipes the handheld, removing all data such as messages, contacts, etc.
 105 and/or all .cod files, including OS .cod files.
 106 By default, with no options specified, both applications and data are wiped.
 107 Use the switches to specify only applications or data.
 108 .TP
 109 .B erase [\-f] <module name> ...
 110 Delete the specified application module(s).  The module name can be determined
 111 using the 'dir' command.  When used with the \-f option, the module is erased
 112 even if in use, and the device will be reset.
 113 .TP
 114 .B eventlog
 115 Retrives the handheld event log and prints it on stdout.
 116 .TP
 117 .B cleareventlog
 118 Clears the handheld event log.
 119 .TP
 120 .B logstacktraces
 121 Dumps the stack traces for all threads into the event log, which can then
 122 be viewed with the 'eventlog' command.
 123 .TP
 124 .B screenshot <.bmp filename>
 125 Capture current screen image and save in BMP format.
 126 .TP
 127 .B settime [yyyy\-mm\-dd HH:MM:SS]
 128 Sets the time on the handheld to the current time, or the specified time.
 129 If time is given as an argument, the current system timezone is assumed.
 130
 131 .SH AUTHOR
 132 .nh
 133 .B bjavaloader
 134 was initially written for the Barry project by Nicolas Vivien, with
 135 additional contributions from others over time.  This manual page was
 136 written by Chris Frey.
 137 .SH SEE ALSO
 138 .PP
 139 http://www.netdirect.ca/software/packages/barry
 140