aboutsummaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
authorFritz Elfert <felfert@to.com>2002-03-12 13:14:42 +0000
committerFritz Elfert <felfert@to.com>2002-03-12 13:14:42 +0000
commit2142b392bf726c9b90b190fef1de09bc9d46ee5c (patch)
treedbd4a08e0bc48483f82866484e7d565f2dd853a6 /doc
parente80f6230aea18d8a7d79bfe7f87d87adb160ff61 (diff)
downloadplptools-2142b392bf726c9b90b190fef1de09bc9d46ee5c.tar.gz
plptools-2142b392bf726c9b90b190fef1de09bc9d46ee5c.tar.bz2
plptools-2142b392bf726c9b90b190fef1de09bc9d46ee5c.zip
Updated man pages to reflect new unified options.
Diffstat (limited to 'doc')
-rw-r--r--doc/ncpd.man.in37
-rw-r--r--doc/plpftp.man.in21
-rw-r--r--doc/plpnfsd.man.in25
3 files changed, 57 insertions, 26 deletions
diff --git a/doc/ncpd.man.in b/doc/ncpd.man.in
index b2575a0..d14779b 100644
--- a/doc/ncpd.man.in
+++ b/doc/ncpd.man.in
@@ -12,11 +12,14 @@ ncpd \- Daemon which handles the serial link to a Psion
.SH SYNOPSIS
.B ncpd
.B [-V]
+.B [-h]
.BI "[-v " logclass ]
.B [-d]
-.BI "[-p " port ]
+.B [-e]
+.BI "[-p [" host ":]" port ]
.BI "[-s " device ]
.BI "[-b " baudrate ]
+.BI [ long-options ]
.SH DESCRIPTION
ncpd is the daemon which handles the serial link to your Psion.
@@ -27,12 +30,22 @@ can run always in background (if you have a spare serial-device)
.SH OPTIONS
.TP
-.B \-V
+.B \-V, --version
Display the version and exit
.TP
-.BI "\-v " logclass
+.B \-h, --help
+Display a short help text and exit.
+.TP
+.B \-e, --autoexit
+Exit automatically, if the device is disconnected. Furthermore, use the
+current tty as I/O device. This option is intended for starting ncpd on
+demand using mgetty's auto-detect function. (A patch for mgetty is needed
+for that).
+.TP
+.BI "\-v, --verbose=" logclass
Increase the logging level of the program. the possible values for logclass
are:
+.RS
.TP
.I nl
Set NCP debug level to LOG
@@ -60,20 +73,24 @@ Set overall debug level to verbose
.TP
.I all
Turn on all the above logging on.
-
+.RE
.TP
-.B \-d
+.B "\-d, --dontfork"
Do not background the daemon.
.TP
-.BI "\-p " port
-Specify the port to listen on - by default this is looked up in
-/etc/services. If it is not found there, a builtin value of @DPORT@ is used.
+.BI "\-p, --port=[" host: ] port
+Specify the port to listen on - by default the value for the host is
+127.0.0.1 and the value for the port is looked up in /etc/services using
+the key
+.B psion/tcp.
+If it is not found there, a builtin value of @DPORT@
+is used.
.TP
-.BI "\-s " device
+.BI "\-s, --serial=" device
Specify the serial device to use to connect to the Psion - this defaults to
@DDEV@
.TP
-.BI "\-b " baudrate
+.BI "\-b, --baudrate=" baudrate
Specify the baud rate to use for the serial connection - this defaults to
@DSPEED@ baud.
diff --git a/doc/plpftp.man.in b/doc/plpftp.man.in
index f03de83..b10b9ad 100644
--- a/doc/plpftp.man.in
+++ b/doc/plpftp.man.in
@@ -11,7 +11,10 @@
plpftp \- FTP-like program for manipulating files on the Psion.
.SH SYNOPSIS
.B plpftp
-.BI "[-p " port ]
+.B [-h]
+.B [-V]
+.BI "[-p [" host :] port ]
+.BI [ long-options ]
.BI "[ " ftpcommand " [" parameters ]]
.SH DESCRIPTION
@@ -25,10 +28,16 @@ enter "help".
.SH OPTIONS
.TP
-.BI "\-p " port
-Specify the port to connect to (e.g. The port where ncpd is listening on) -
-by default this is looked up in /etc/services. If it is not found there,
-a builtin value of @DPORT@ is used.
+.B \-V, --version
+Display the version and exit
+.TP
+.B \-h, --help
+Display a short help text and exit.
+.TP
+.BI "\-p, --port=[" host :] port
+Specify the host and port to connect to (e.g. The port where ncpd is
+listening on) - by default the host is 127.0.0.1 and the port is looked up
+in /etc/services. If it is not found there, a builtin value of @DPORT@ is used.
.TP
.I ftpcommand parameters
Allows you to specify an plpftp command on the command line. If specified,
@@ -36,7 +45,7 @@ plpftp enters non interactive mode and terminates after executing the
command.
.SH SEE ALSO
-ncpd(8), plpncpd(8)
+ncpd(8), plpnfsd(8)
.SH AUTHOR
Fritz Elfert
diff --git a/doc/plpnfsd.man.in b/doc/plpnfsd.man.in
index 4ab4304..e600c68 100644
--- a/doc/plpnfsd.man.in
+++ b/doc/plpnfsd.man.in
@@ -13,9 +13,12 @@ plpnfsd \- Daemon to mount a Psion an nfs like filesystem
.B plpnfsd
.B [-V]
.B [-v]
-.BI "[-p " port ]
+.B [-D]
+.B [-h]
+.BI "[-p [" host :] port ]
.BI "[-d " mountdir ]
.BI "[-u " user ]
+.BI [ long-options ]
.SH DESCRIPTION
plpnfsd is a daemon, which provides NFS-like access to your Psion.
@@ -38,26 +41,28 @@ will reappear. (possibly with a few secs delay)
.SH OPTIONS
.TP
-.B \-V
+.B \-V, --version
Display the version and exit
.TP
-.B \-v
+.B \-h, --help
+Display a short help text and exit.
+.TP
+.B \-v, --verbose
Produce verbose logging output. Can be specified more than once to increase the
debug level (up to 3 times)
-
.TP
-.BI "\-p " port
-Specify the port to connect to (e.g. the port where ncpd is listening on) - by
-default, the port is looked up in /etc/services. If it is not found there,
-a fallback builtin of
+.BI "\-p, --port=[" host :] port
+Specify the host and port to connect to (e.g. the port where ncpd is listening
+on) - by default the host is 127.0.0.1 and the port is looked up in
+/etc/services. If it is not found there, a fallback builtin of
.I @DPORT@.
.TP
-.BI "\-d " mountdir
+.BI "\-d, --mountpoint=" mountdir
Specify the directory to mount the psion file system on. This defaults
to
.I @DMOUNTPOINT@
.TP
-.BI "\-u " user
+.BI "\-u, --user=" user
Specify the user who will own the psion files. This defaults to the user
who is running plpnfsd. If the user running plpnfsd is
.I root