From 286c6d60fa96e53c7b261a60ca8abe680197c6c3 Mon Sep 17 00:00:00 2001 From: Fritz Elfert Date: Thu, 10 Aug 2000 19:36:14 +0000 Subject: Added man pages by John Lines (john+plpman@paladin.demon.co.uk). Started support for procfs-like extension in plpnfsd. --- doc/Makefile.am | 13 ++++++++ doc/ncpd.man.in | 89 ++++++++++++++++++++++++++++++++++++++++++++++++++++++ doc/plpftp.man.in | 46 ++++++++++++++++++++++++++++ doc/plpnfsd.man.in | 76 ++++++++++++++++++++++++++++++++++++++++++++++ 4 files changed, 224 insertions(+) create mode 100644 doc/ncpd.man.in create mode 100644 doc/plpftp.man.in create mode 100644 doc/plpnfsd.man.in (limited to 'doc') diff --git a/doc/Makefile.am b/doc/Makefile.am index 10e4f47..c989bbf 100644 --- a/doc/Makefile.am +++ b/doc/Makefile.am @@ -1 +1,14 @@ SUBDIRS = api + +EXTRA_DIST = ncpd.man.in plpnfsd.man.in plpftp.man.in + +man_MANS = ncpd.8 plpnfsd.8 plpftp.1 + +%.1: %.man + MANDATE=`grep CHECKIN $< | $(AWK) '{print $$4}'` ; \ + $(SED) -e "s%@MANDATE@%$$MANDATE%g" $< > $@ + +%.8: %.man + MANDATE=`grep CHECKIN $< | $(AWK) '{print $$4}'` ; \ + $(SED) -e "s%@MANDATE@%$$MANDATE%g" $< > $@ + diff --git a/doc/ncpd.man.in b/doc/ncpd.man.in new file mode 100644 index 0000000..86e99ef --- /dev/null +++ b/doc/ncpd.man.in @@ -0,0 +1,89 @@ +.\" Manual page for ncpd +.\" $Id$ +.\" CHECKIN $Date$ +.\" +.\" Process this file with +.\" groff -man -Tascii ncpd.8 for ASCII output, or +.\" groff -man -Tps ncpd.8 for PostScript output +.\" +.TH ncpd 8 "@MANDATE@" "plptools @VERSION@" "System Administration" +.SH NAME +ncpd \- Daemon which handles the serial link to a Psion +.SH SYNOPSIS +.B ncpd +.B [-V] +.BI "[-v " logclass ] +.B [-d] +.BI "[-p " port ] +.BI "[-s " device ] +.BI "[-b " baudrate ] + +.SH DESCRIPTION +ncpd is the daemon which handles the serial link to your Psion. +It listens at port @DPORT@ for local connections and provides +basic PLP/NCP services for plpnfsd and plpftp. It autoconnects +to the psion, even after unplugging/switching off therefore it +can run always in background (if you have a spare serial-device) + +.SH OPTIONS +.TP +.B \-V +Display the version and exit +.TP +.BI "\-v " logclass +Increase the logging level of the program. the possible values for logclass +are: +.TP +.I nl +Set NCP debug level to LOG +.TP +.I nd +Set NCP debug level to DEBUG +.TP +.I ll +Set Link debug level to LOG +.TP +.I ld +Set Link debug level to DEBUG +.TP +.I pl +Set Packet debug level to LOG +.TP +.I pd +Set Packet debug level to DEBUG +.TP +.I ph +Set Packet debug level to HANDSHAKE +.TP +.I m +Set overall debug level to verbose +.TP +.I all +Turn on all the above logging on. + +.TP +.B \-d +Do not background the daemon. +.TP +.BI "\-p " port +Specify the port to listen on - by default this is @DPORT@ +.TP +.BI "\-s " device +Specify the serial device to use to connect to the Psion - this defaults to +@DDEV@ +.TP +.BI "\-b " baudrate +Specify the baud rate to use for the serial connection - this defaults to +@DSPEED@ baud. + +.SH SEE ALSO +plpftp(1), plpnfsd(8) + +.SH AUTHOR +Fritz Elfert +Heavily based on p3nfsd by Rudolf Koenig (rfkoenig@immd4.informatik.uni-erlangen.de) +and +plp_1_7 by Philip Proudman (phil@proudman51.freeserve.co.uk) +Patches from Matt Gumbley (matt@gumbley.demon.co.uk) +Man page by John Lines (john+plpman@paladin.demon.co.uk) + diff --git a/doc/plpftp.man.in b/doc/plpftp.man.in new file mode 100644 index 0000000..cc12b35 --- /dev/null +++ b/doc/plpftp.man.in @@ -0,0 +1,46 @@ +.\" Manual page for plpftp +.\" $Id$ +.\" CHECKIN $Date$ +.\" +.\" Process this file with +.\" groff -man -Tascii plpftp.1 for ASCII output, or +.\" groff -man -Tps plpftp.1 for PostScript output +.\" +.TH plpftp 1 "@MANDATE@" "plptools @VERSION@" local +.SH NAME +plpftp \- FTP-like program for manipulating files on the Psion. +.SH SYNOPSIS +.B plpftp +.BI "[-p " port ] +.BI "[ " ftpcommand " [" parameters ]] + +.SH DESCRIPTION + +plpftp provides an ftp style interface for the psion. It requires the ncpd to +be running already to provide access to the serial port. + +plpftp has online help. To see the available commands start the program and +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 @DPORT@ +.TP +.I ftpcommand parameters +Allows you to specify an plpftp command on the command line. If specified, +plpftp enters non interactive mode and terminates after executing the +command. + +.SH SEE ALSO +ncpd(8), plpncpd(8) + +.SH AUTHOR +Fritz Elfert +Heavily based on p3nfsd by Rudolf Koenig (rfkoenig@immd4.informatik.uni-erlangen.de) +and +plp_1_7 by Philip Proudman (phil@proudman51.freeserve.co.uk) +Man page by John Lines (john+plpman@paladin.demon.co.uk) + diff --git a/doc/plpnfsd.man.in b/doc/plpnfsd.man.in new file mode 100644 index 0000000..d1b1057 --- /dev/null +++ b/doc/plpnfsd.man.in @@ -0,0 +1,76 @@ +.\" Manual page for plpnfsd +.\" $Id$ +.\" CHECKIN $Date$ +.\" +.\" Process this file with +.\" groff -man -Tascii plpnfsd.8 for ASCII output, or +.\" groff -man -Tps plpnfsd.8 for PostScript output +.\" +.TH plpnfsd 8 "@MANDATE@" "plptools @VERSION@" "System Administration" +.SH NAME +plpnfsd \- Daemon to mount a Psion an nfs like filesystem +.SH SYNOPSIS +.B plpnfsd +.B [-V] +.B [-v] +.BI "[-p " port ] +.BI "[-d " mountdir ] +.BI "[-u " user ] + +.SH DESCRIPTION +plpnfsd is a daemon, which provides NFS-like access to your Psion. +It automatically makes the psion's filesystems available below +an NFS-mounted directory (default /mnt/psion). +By default, plpnfsd is installed suid-root, so any normal user +can start it and get's the mounted directory owned by himself. +As this program is usually used on single-user machines, this +does not hurt security. Like the others, this program +auto-reconnects after a link-failure, so you can keep the +psion mounted all the time, even when it is not connected. +Due to Rudolf Koenig's clever error-handling, you don't need to +worry about blocked io-processes if the psion isn't available. +You simply will get an "device not configured" error, when +accessing a file on a previously connected psion which has been +disconnected. After that, the mount-point will appear empty. +As soon as the psion is connected again, the subdirectories +will reappear. (possibly with a few secs delay) + + +.SH OPTIONS +.TP +.B \-V +Display the version and exit +.TP +.B \-v +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 this is +.I @DPORT@. +.TP +.BI "\-d " mountdir +Specify the directory to mount the psion file system on. This defaults +to +.I @DMOUNTPOINT@ +.TP +.BI "\-u " 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 +, s/he may +also specify a different user. + +.SH SEE ALSO +ncpd(8), plpftp(1) + +.SH AUTHOR +Fritz Elfert +Heavily based on p3nfsd by Rudolf Koenig (rfkoenig@immd4.informatik.uni-erlangen.de) +and +plp_1_7 by Philip Proudman (phil@proudman51.freeserve.co.uk) +Patches from Matt Gumbley (matt@gumbley.demon.co.uk) +Man page by John Lines (john+plpman@paladin.demon.co.uk) + -- cgit v1.2.3