← Back to branch summary

~ubuntu-branches/ubuntu/edgy/pilot-link/edgy

« back to all changes in this revision

Viewing changes to doc/man/dlpsh.1.in

  • Committer: Bazaar Package Importer
  • Author(s): Ludovic Rousseau
  • Date: 2006-09-22 11:51:36 UTC
  • mfrom: (3.1.8 edgy)
  • Revision ID: james.westby@ubuntu.com-20060922115136-qqmy17bx8j5x0y72
Tags: 0.12.1-5
* urgency medium since libpisock-dev was not usable to build any package
* libpisock-dev now depends on libusb-dev

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/man/dlpsh.1.in
1
 
.TH "dlpsh" "1" "pilot-link - @VERSION@" "(c) FSF 1996-2003" "Conduits"
2
 
.SH "NAME"
3
 
\fBdlpsh\fR is a command "shell" for executing DLP (Desktop Link Protocol) commands to a Palm handheld.
4
 
 
5
 
 
6
 
.SH "SYNOPSIS"
7
 
\fBdlpsh\fR [\fB\-p\fR <port>]
8
 
 
9
 
 
10
 
.SH "DESCRIPTION"
11
 
\fBdlpsh\fR allows the user to connect to a Palm handheld and execute arbitrary DLP commands. Once connected, the user may execute most of the built\-in \fBDLP\fR commands. (See \fBBUILT\-IN COMMANDS\fR below for more detail on currently supported options).
12
 
 
13
 
.br 
14
 
The connection to the Pilot is kept alive by sending a
15
 
\fIPadTickle\fR packet to the Pilot after a small period of non\-activity. (7 seconds by default)
16
 
 
17
 
 
18
 
.SH "BUILT\-IN COMMANDS"
19
 
There are many options available while connected to your Palm handheld via \fBdlpsh\fR, including the following. 
20
 
 
21
 
.TP 
22
 
\fBuser\fR
23
 
Print the currently set User information, including Username, UserID, PCid, and ViewerID. You may also set these values from this command as well. Use 'user --help' while connected to see details on how to set or change these values.
24
 
 
25
 
.TP 
26
 
\fBls\fR
27
 
Used with \-l and \-r to provide long and RAM and ROM file lists, similar to the Unix 'ls' command. This does not yet allow you to narrow your listing to a certain range of files. It will simply list them all.
28
 
 
29
 
.TP 
30
 
\fBdf\fR
31
 
Display how much RAM and ROM is free on your device, again similar to the Unix 'df' command. This does not accept arguments at this time.
32
 
 
33
 
.TP 
34
 
\fBtime\fR
35
 
Set the time on the Palm from the currently-set desktop time. This does not work on OS version 3.3, due to a bug in PalmOS at that time. 
36
 
 
37
 
.TP 
38
 
\fBrm\fR
39
 
Remove a file and delete it entirely from the Palm device. This is an irrevokable process, and you cannot "undelete" a file, once it has been deleted with this command.
40
 
 
41
 
.TP 
42
 
\fBquit\fR
43
 
Exit the DLP Protocol Shell
44
 
 
45
 
 
46
 
.SH "OPTIONS"
47
 
While in \fBdlpsh\fR, you can always invoke 'help' or <option> \-\-help to get further information on that option.
48
 
 
49
 
 
50
 
.SH "USAGE"
51
 
The program will connect to your Palm handheld and give the user an interactive prompt (a "shell") for executing commands across the DLP \fIHotSync\fR protocol.
52
 
 
53
 
 
54
 
.SH "BUGS"
55
 
.PP 
56
 
\fBKNOWN BUGS\fR
57
 
    
58
 
.IP 
59
 
\fBdlpsh\fR has no known bugs at this time.
60
 
   
61
 
.PP 
62
 
\fBREPORTING BUGS\fR
63
 
   
64
 
.IP 
65
 
Report bugs at \fIhttp://bugs.pilot\-link.org/\fR
66
 
.SH "AUTHOR"
67
 
\fBdlpsh\fR was originally written by Chris Stevens <\fIstevens@rpi.edu\fR> and Damien Neil <\fIneild@rpi.edu\fR>