You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

139 lines
4.6 KiB

.\"Generated by db2man.xsl. Don't modify this, modify the source.
.de Sh \" Subsection
.br
.if t .Sp
.ne 5
.PP
\fB\\$1\fR
.PP
..
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Ip \" List item
.br
.ie \\n(.$>=3 .ne \\$3
.el .ne 3
.IP "\\$1" \\$2
..
.TH "pilot-getram" 1 "Copyright 1996-2007 FSF" "0.12.5" "PILOT-LINK"
.SH NAME
pilot-getram \- Retrieves the RAM image from your Palm device for use in debugging.
.SH "SECTION"
.PP
pilot\-link: Tools
.SH "SYNOPSIS"
.PP
\fIpilot\-getram\fR [\fB\-p\fR|\fB\-\-port\fR <\fBport\fR>] [\fB\-\-version\fR] [\fB\-q\fR|\fB\-\-quiet\fR] [\fB\-?\fR|\fB\-\-help\fR] [\fB\-\-usage\fR] [\fB\-t\fR|\fB\-\-token\fR \fBtoken\fR] [\fB\-s\fR|\fB\-\-sysinfo\fR] [\fB\-\-ram\fR] [\fB\-\-rom\fR] [\fIfilename\fR]
.SH "DESCRIPTION"
.PP
\fIpilot\-getram\fR is used to fetch the current RAM image from your Palm handheld for use in debugging\&.
.PP
\fIpilot\-getromtoken\fR, \fIpilot\-getrom\fR and \fIpilot\-getram\fR are inter\-related\&. All relevant code is implemented in \fIpilot\-getrom\fR, and you can do \fIpilot\-getromtoken\fR \fB\-\-ram\fR \fIfilename\fR to get the RAM dump if you like\&.
.PP
Note, because \fIpilot\-getrom\fR uses the low\-level RPC protocol to fetch the ROM image, and the new OS5 devices do not use this protocol, you currently cannot fetch an OS5 ROM image using this utility\&. This will be updated in a future release to handle fetching OS5 ROM images, using the debugger protocol\&.
.SH "OPTIONS"
.SS "pilot-getram options"
\fB\-t\fR,
\fB\-\-token\fR \fBtoken\fR
.PP
A ROM token to read (i\&.e\&. snum)
\fB\-s\fR, \fB\-\-sysinfo\fR
.PP
Print SysInfo
\fB\-\-ram\fR
.PP
Read RAM
\fB\-\-rom\fR
.PP
Read ROM
<\fBfilename\fR>
.PP
Write the RAM image to the file named by <\fIfilename\fR>\&. If this is omitted, the filename will be written out as the RAM version name as follows: '\fI pilot\-$VERSION\&.ram \fR ', where an OS 3\&.5 image would be written as the filename of '\fIpilot\-3\&.5\&.0\&.ram\fR'\&.
.SS "Conduit Options"
\fB\-p\fR, \fB\-\-port\fR
<\fBport\fR>
.PP
Use device file <\fIport\fR> to communicate with the Palm handheld\&. If this is not specified, \fIpilot\-getram\fR will look for the \fI$PILOTPORT\fR environment variable\&. If neither are found or supplied, \fI pilot\-getram \fR will print the usage information\&.
\fB\-q\fR,
\fB\-\-quiet\fR
.PP
Suppress 'Hit HotSync button' message
\fB\-v\fR, \fB\-\-version\fR
.PP
Display version of \fIpilot\-getram\fR and exit without connecting\&.
.SS "Help Options"
\fB\-h\fR, \fB\-\-help\fR
.PP
Display the help synopsis for \fIpilot\-getram\fR and exit without connecting\&.
\fB\-\-usage\fR
.PP
Display a brief usage message and exit without connecting\&.
.SH "USAGE"
.PP
Connect to a target Palm handheld and fetch the RAM from the device\&.
.SH "AUTHOR"
.PP
\fIpilot\-getram\fR was originally written by Kenneth Albanowski\&.
.PP
This manual page was converted to XML by Neil Williams <linux@codehelp\&.co\&.uk>
.SH "REPORTING BUGS"
.PP
We have an online bug tracker\&. Using this is the only way to ensure that your bugs are recorded and that we can track them until they are resolved or closed\&. Reporting bugs via email, while easy, is not very useful in terms of accountability\&. Please point your browser to http://bugs\&.pilot\-link\&.org: \fIhttp://bugs.pilot-link.org\fR and report your bugs and issues there\&.
.SH "COPYRIGHT"
.PP
This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version\&.
.PP
This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE\&. See the GNU General Public License for more details\&.
.PP
You should have received a copy of the GNU General Public License along with this program; if not, write to the Free Software Foundation, Inc\&., 51 Franklin St, Fifth Floor, Boston, MA 02110\-1301, USA\&.
.SH "SEE ALSO"
.PP
\fIpilot\-getrom\fR (1), \fIpilot\-link\fR(7)\&.