aboutsummaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
authorDaniel Brahneborg <basic@chello.se>2002-04-02 18:09:56 +0000
committerDaniel Brahneborg <basic@chello.se>2002-04-02 18:09:56 +0000
commit6d15533ada3dc236e0984a6e9665db8c150bd01f (patch)
treeb80ac92b37867c81c800ff5dc9d7f4486e837e99 /doc
parentf1d4a4d9ee83477ad80a2f1f2d19e35ae0172fc0 (diff)
downloadplptools-6d15533ada3dc236e0984a6e9665db8c150bd01f.tar.gz
plptools-6d15533ada3dc236e0984a6e9665db8c150bd01f.tar.bz2
plptools-6d15533ada3dc236e0984a6e9665db8c150bd01f.zip
Added a small man file for sisinstall.
Diffstat (limited to 'doc')
-rw-r--r--doc/Makefile.am4
-rw-r--r--doc/sisinstall.man.in59
2 files changed, 61 insertions, 2 deletions
diff --git a/doc/Makefile.am b/doc/Makefile.am
index 2387ae8..f2303f8 100644
--- a/doc/Makefile.am
+++ b/doc/Makefile.am
@@ -1,8 +1,8 @@
SUBDIRS = api
-EXTRA_DIST = ncpd.man.in plpnfsd.man.in plpftp.man.in
+EXTRA_DIST = ncpd.man.in plpnfsd.man.in plpftp.man.in sisinstall.man.in
-man_MANS = ncpd.8 plpnfsd.8 plpftp.1
+man_MANS = ncpd.8 plpnfsd.8 plpftp.1 sisinstall.1
%.1: %.man
MANDATE=`grep CHECKIN $< | $(AWK) '{print $$4}'` ; \
diff --git a/doc/sisinstall.man.in b/doc/sisinstall.man.in
new file mode 100644
index 0000000..99794f3
--- /dev/null
+++ b/doc/sisinstall.man.in
@@ -0,0 +1,59 @@
+.\" Manual page for sisinstall
+.\" $Id$
+.\" CHECKIN $Date$
+.\"
+.\" Process this file with
+.\" groff -man -Tascii sisinstall.1 for ASCII output, or
+.\" groff -man -Tps sisinstall.1 for PostScript output
+.\"
+.TH sisinstall 1 "@MANDATE@" "plptools @VERSION@" local
+.SH NAME
+sisinstall \- simple command line program for installing
+packaged programs or libraries on the Psion.
+.SH SYNOPSIS
+.B sisinstall
+.B [-h]
+.B [-V]
+.B [-n]
+.BI "[-l " level ]
+.BI [ long-options ]
+.B FILE
+
+.SH DESCRIPTION
+
+sisinstall installs a packaged program or library from a sis file to a
+Psion machine.
+It requires the ncpd to be running already to provide access to the
+Psion machine over the serial port.
+
+.SH OPTIONS
+
+.TP
+.B \-V, --version
+Display the version and exit
+.TP
+.B \-h, --help
+Display a short help text and exit.
+.TP
+.B \-n, --dryryn
+Just parse the sis file, don't touch the Psion machine.
+.TP
+.BI "\-l, --loglevel=" level
+Specify the log level.
+
+Level 0 is the default, and is pretty quiet.
+
+Level 1 provides detailed information on the data that is read.
+
+Level 2 is rather verbose, and is mostly meant for debugging.
+
+.SH BUGS
+Ignores dependency records in the sis file.
+
+.SH SEE ALSO
+ncpd(8), plpftp(1)
+
+.SH AUTHOR
+Written by Daniel Brahneborg (basic@chello.se).
+Psion communication based on plpftp by Fritz Elfert (felfert@to.com).
+