From d573cefae4d7fa3f599d5631ad6991feb528ff37 Mon Sep 17 00:00:00 2001 From: Fritz Elfert Date: Thu, 11 Jul 2002 17:37:54 +0000 Subject: - Added manpages for new programs - Auto-generate ChangeLog in dist target --- doc/Makefile.am | 5 +- doc/ncpd.man.in | 2 +- doc/plpbackup.man.in | 130 ++++++++++++++++++++++++++++++++++++++++++++++++++ doc/plpftp.man.in | 2 +- doc/plpnfsd.man.in | 2 +- doc/plpprintd.man.in | 83 ++++++++++++++++++++++++++++++++ doc/sisinstall.man.in | 2 +- 7 files changed, 220 insertions(+), 6 deletions(-) create mode 100644 doc/plpbackup.man.in create mode 100644 doc/plpprintd.man.in (limited to 'doc') diff --git a/doc/Makefile.am b/doc/Makefile.am index f2303f8..0051953 100644 --- a/doc/Makefile.am +++ b/doc/Makefile.am @@ -1,8 +1,9 @@ SUBDIRS = api -EXTRA_DIST = ncpd.man.in plpnfsd.man.in plpftp.man.in sisinstall.man.in +EXTRA_DIST = ncpd.man.in plpnfsd.man.in plpftp.man.in sisinstall.man.in \ + plpprintd.man.in plpbackup.man.in -man_MANS = ncpd.8 plpnfsd.8 plpftp.1 sisinstall.1 +man_MANS = ncpd.8 plpnfsd.8 plpftp.1 sisinstall.1 plpprintd.8 plpbackup.1 %.1: %.man MANDATE=`grep CHECKIN $< | $(AWK) '{print $$4}'` ; \ diff --git a/doc/ncpd.man.in b/doc/ncpd.man.in index 03ffda9..e5c09d2 100644 --- a/doc/ncpd.man.in +++ b/doc/ncpd.man.in @@ -97,7 +97,7 @@ is specified, ncpd cycles through baudrates of 115200, 57600, 38400, 19200 and 9600 baud. Default setting is @DSNAME@. .SH SEE ALSO -plpftp(1), plpnfsd(8) +ncpd(8), plpnfsd(8), plpprintd(8), plpftp(1) and sisinstall(1) .SH AUTHOR Fritz Elfert diff --git a/doc/plpbackup.man.in b/doc/plpbackup.man.in new file mode 100644 index 0000000..a4b5cd5 --- /dev/null +++ b/doc/plpbackup.man.in @@ -0,0 +1,130 @@ +.\" Manual page for plpbackup +.\" $Id$ +.\" CHECKIN $Date$ +.\" +.\" Process this file with +.\" groff -man -Tascii plpbackup.1 for ASCII output, or +.\" groff -man -Tps plpbackup.1 for PostScript output +.\" +.TH plpbackup 1 "@MANDATE@" "plptools @VERSION@" local +.SH NAME +plpbackup \- Backup and restore for Psion data. +.SH SYNOPSIS +.B plpbackup +.B [-h] +.B [-v] +.B [-q] +.B [-f] +.BI "[-b [" archivename ]] +.BI "[-r " archivename ] +.B [-F] +.B [-V] +.BI "[-p [" host :] port ] +.BI [ long-options ] +.BI [ drive: "] [" drive: ] ... + +.SH DESCRIPTION + +plpbackup provides a facility for backup and restore of Psion drives on +your PC. It also can format Psion drives before performing a restore. + +.SH OPTIONS + +.TP +.B \-h, --help +Display a short help text and exit. +.TP +.B \-v, --verbose +Increase verbosity +.TP +.B \-q, --quiet +Decrease verbosity +.TP +.B \-f, --full +Perform a full backup of the specified drives. If this option +is missing, an incremental backup is done based on the archive bit in the +file attributes on the Psion. Archive bits of backed-up files are cleared +after any successful backup operation. +.TP +.BI "\-b, --backup[=" archivename ] +Select backup mode. This mode and restore mode are mutually exclusive. +If +.I archivename +is missing, plpbackup automatically selects an archive name using the +following scheme: +.BI $HOME/plpbackup/ PsionUID / T \- YYYY \- MM \- DD \- hh \- mm \- ss .tar.gz +, where +.RS +.TP +.I PsionUID +is the Psion's unique machine id. If connected to a Series 3 which does not +provide a machine id, during first backup of that Psion an artificial machine +id is calculated from the contents of the Psion's owner-info. This id is then +written on the Psion's default drive +.B M: +into the file +.BR SYS$PT.CFG . +and used on subsequent operations. +.TP +.I T +is a single character +.BR F " or " I +representing full or incremental respectively. +.TP +.I YYYY +is the current year. +.TP +.I MM +is the current month. +.TP +.I DD +is the current day. +.TP +.I hh +is the current hour. +.TP +.I mm +is the current minute. +.TP +.I mm +is the current second. +.RE +.TP +.BI "\-r, --restore=" archivename +Select restore mode. This mode and backup mode are mutually exclusive. +Before restoring data, plpbackup asks interactively, if you want to +restore individual files or the whole contents of the archive. If you +select individual files, plpbackup extracts a listing of the archive's +contents into a temporary file and starts an editor with this file. +Using the editor, you then can mark the files to restore. The default +editor to be used can be specified in the environment variable +.BR EDITOR . +If this environment variable is not available, the builtin default +.B vi +is used. +.TP +.B \-F, --format +Format specified drives. This option can be combined with restore mode. +.B USE WITH EXTREME CARE! +.TP +.B \-V, --version +Display the version 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 drive: +The Psion's drive character to be selected for backup or restore. Multiple +drive characters can be specified. In backup mode, this option can be omitted +to have plpbackup scan for all available drives on the Psion. + +.SH FILES + +.SH SEE ALSO +ncpd(8), plpnfsd(8), plpprintd(8), plpftp(1) and sisinstall(1) + +.SH AUTHOR +Fritz Elfert + diff --git a/doc/plpftp.man.in b/doc/plpftp.man.in index b10b9ad..274fd78 100644 --- a/doc/plpftp.man.in +++ b/doc/plpftp.man.in @@ -45,7 +45,7 @@ plpftp enters non interactive mode and terminates after executing the command. .SH SEE ALSO -ncpd(8), plpnfsd(8) +ncpd(8), plpnfsd(8), plpprintd(8), plpftp(1) and sisinstall(1) .SH AUTHOR Fritz Elfert diff --git a/doc/plpnfsd.man.in b/doc/plpnfsd.man.in index e600c68..9bbb1bd 100644 --- a/doc/plpnfsd.man.in +++ b/doc/plpnfsd.man.in @@ -103,7 +103,7 @@ Shows the name of the corresponding process on the Psion. Shows the arguments of the corresponding process on the Psion. .SH SEE ALSO -ncpd(8), plpftp(1) +ncpd(8), plpnfsd(8), plpprintd(8), plpftp(1) and sisinstall(1) .SH AUTHOR Fritz Elfert diff --git a/doc/plpprintd.man.in b/doc/plpprintd.man.in new file mode 100644 index 0000000..8fc2d27 --- /dev/null +++ b/doc/plpprintd.man.in @@ -0,0 +1,83 @@ +.\" Manual page for plpprintd +.\" $Id$ +.\" CHECKIN $Date$ +.\" +.\" Process this file with +.\" groff -man -Tascii plpprintd.1 for ASCII output, or +.\" groff -man -Tps plpprintd.1 for PostScript output +.\" +.TH plpprintd 8 "@MANDATE@" "plptools @VERSION@" local +.SH NAME +plpprintd \- Daemon for printing via PC from a Psion. +.SH SYNOPSIS +.B plpprintd +.B [-d] +.B [-h] +.B [-v] +.B [-V] +.BI [-s " spooldir" ] +.BI [-c " printcmd" ] +.BI "[-p [" host :] port ] +.BI [ long-options ] + +.SH DESCRIPTION + +plpprintd provides a print server for a Psion, connected to the PC. +Using plpprintd, you can use the Psion's "Print via PC" feature to +access any printer, available on your PC. When receiving a print job, +the data is converted to PostScript® + +.SH OPTIONS + +.TP +.B \-d, --debug +Enable additional debug messages and stay in foreground (do not fork). +.TP +.B \-h, --help +Display a short help text and exit. +.TP +.B \-v, --verbose +Increase verbosity +.TP +.B \-V, --version +Display the version and exit +.TP +.BI "\-s, --spooldir=" dir +Specify a directory to use for temporary spool files. If this option is +missing, a builtin default +.I /var/spool/plpprint +is used. +.TP +.BI "\-c, --printcmd=" cmd +Specify a command for actually sending a print job to the printer. The +specified command must receive the data from its standard input. If this +option is missing, a builtin default +.I lpr \-Ppsion +is used. +.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 + +.SH FILES +.TP +@PKGDATA@/prolog.ps +contains the PostScript® dictionary, needed for printing the jobs. +.TP +@PKGDATA@/fontmap +specifies the font mapping to be used. This file is used to convert the +Psion's font names into valid PostScript® font names. It's format is +described at the beginning of it. If a Psion font name is received which +can not be found in this file, a builtin default Courier is used. + +.SH BUGS +Using patterns in diagrams gives ugly results. + +.SH SEE ALSO +ncpd(8), plpnfsd(8), plpprintd(8), plpftp(1) and sisinstall(1) + +.SH AUTHOR +Fritz Elfert + diff --git a/doc/sisinstall.man.in b/doc/sisinstall.man.in index 0fcb649..04666ac 100644 --- a/doc/sisinstall.man.in +++ b/doc/sisinstall.man.in @@ -51,7 +51,7 @@ Level 2 is rather verbose, and is mostly meant for debugging. Ignores dependency records in the sis file. .SH SEE ALSO -ncpd(8), plpftp(1) +ncpd(8), plpnfsd(8), plpprintd(8), plpftp(1) and sisinstall(1) .SH AUTHOR Written by Daniel Brahneborg (basic@chello.se). -- cgit v1.2.3