linux-avmb1:capi4k-utils manpages

[Matthias Klose]

Please find attached some patches to add manpages for most of the
commands.


-------------- next part --------------

# DP: Add capifax manpages

diff -urN capifax.orig/Makefile.am capifax/Makefile.am
--- capifax.orig/Makefile.am	2000-03-03 16:54:12.000000000 +0100
+++ capifax/Makefile.am	2004-10-29 00:56:04.000000000 +0200
@@ -13,6 +13,7 @@
 LDADD = -lcapi20
 
 bin_PROGRAMS = capifax capifaxrcvd
+man_MANS = capifax.1 capifaxrcvd.8
 
 common = c20msg.c capi.c connect.c contr.c data.c id.c init.c fax.c
 
diff -urN capifax.orig/capifax.1 capifax/capifax.1
--- capifax.orig/capifax.1	1970-01-01 01:00:00.000000000 +0100
+++ capifax/capifax.1	2004-10-29 00:51:49.000000000 +0200
@@ -0,0 +1,37 @@
+.\" $Id: capifax.1,v 1.1 2002/07/04 11:30:59 paul Exp $
+.\"
+.\" CHECKIN $Date: 2002/07/04 11:30:59 $
+.\"
+.TH capifax 1
+.SH NAME
+capifax \- a FAX send application for CAPI
+.SH SYNOPSIS
+capifax [ -v ] [ -c calling_party_num ] [ -i station_ID ] [-h headline] dest_num
+.SH DESCRIPTION
+.B capifax
+is an application to send faxes via CAPI; you need a CAPI capable ISDN
+card with the appropriate drivers.
+
+The final argument must be the phone number of the receiving fax machine.
+
+This stuff is based heavily on AVM's CAPI-adk for linux.
+
+.SH OPTIONS
+.TP
+.BI -v
+Be verbose.
+
+.TP
+.BI "-c" " calling_party_num"
+the phone number used as the sender.
+
+.TP
+.BI "-i" " station_ID"
+the sender's station ID. Typically the company name or similar.
+
+.TP
+.BI "-h" " headline"
+title of sent document.
+
+.SH AUTHOR
+manpage written from C source by Paul Slootman <paul at debian.org>.
diff -urN capifax.orig/capifaxrcvd.8 capifax/capifaxrcvd.8
--- capifax.orig/capifaxrcvd.8	1970-01-01 01:00:00.000000000 +0100
+++ capifax/capifaxrcvd.8	2004-10-29 00:52:28.000000000 +0200
@@ -0,0 +1,57 @@
+.\" $Id: capifaxrcvd.8,v 1.1 2002/07/04 11:30:59 paul Exp $
+.\"
+.\" CHECKIN $Date: 2002/07/04 11:30:59 $
+.\"
+.TH capifaxrcvd 8
+.SH NAME
+capifaxrcvd \- a FAX receive daemon for CAPI
+.SH SYNOPSIS
+capifaxrcvd [-i stationID] [-h header] [-c controller] [-l listenNumber] [-n notifyCmd] rcvDirectory
+.SH DESCRIPTION
+.B capifaxrcvd
+is a daemon to receive faxes via CAPI; you need a CAPI capable ISDN
+card with the appropriate drivers.
+
+The final argument must be the directory in which the
+received faxes are to be placed.
+The filenames of the received faxes are of the form:
+.br
+f[fn]xxxtttttttt
+.br
+[fn] indicates the resolution (fine or normal),
+.br
+xxx indicated the number of pages,
+.br
+tttttttt is the (hexadecimal) timestamp of the fax
+(seconds since the Unix epoch, 00:00 on January 1st, 1970 UTC).
+
+The daemon will fork itself into the background.
+
+This stuff is based heavily on AVM's CAPI-adk for linux.
+
+.SH OPTIONS
+.TP
+.BI "-l" " listenNumber"
+the phone number on which to receive faxes, i.e. the number to listen on.
+
+.TP
+.BI "-c" " controller"
+Specify a specific controller number to use for receiving the faxes.
+
+.TP
+.BI "-i" " station_ID"
+the station ID. Typically the company name or similar.
+
+.TP
+.BI "-h" " headline"
+title of sent document. (?)
+
+.TP
+.BI "-n" " notifyCmd"
+command to execute when a fax has been received.
+It will be called with three arguments, namely
+the filename of the received fax (without the directory name),
+the sender phone number, and the receiver phone number.
+
+.SH AUTHOR
+manpage written from C source by Paul Slootman <paul at debian.org>.
-------------- next part --------------
A non-text attachment was scrubbed...
Name: capiinit-manpage.dpatch
Type: application/x-shellscript
Size: 946 bytes
Desc: not available
Url : http://mlists.in-berlin.de/pipermail/linux-avmb1-mlists.in-berlin.de/attachments/20041029/0ff79225/attachment.bin 
-------------- next part --------------

# DP: add rcapid manpage

diff -urN rcapid.old/Makefile.am rcapid/Makefile.am
--- rcapid.old/Makefile.am	2002-07-19 23:23:54.000000000 +0200
+++ rcapid/Makefile.am	2004-07-11 15:08:36.000000000 +0200
@@ -13,5 +13,6 @@
 LDADD = -lcapi20
 
 sbin_PROGRAMS = rcapid
+man_MANS = rcapid.8
 
 rcapid_SOURCES = rcapid.c
diff -urN rcapid.old/rcapid.8 rcapid/rcapid.8
--- rcapid.old/rcapid.8	1970-01-01 01:00:00.000000000 +0100
+++ rcapid/rcapid.8	2002-07-04 13:45:55.000000000 +0200
@@ -0,0 +1,36 @@
+.\" $Id: rcapid.8,v 1.1 2002/07/04 11:45:55 paul Exp $
+.\"
+.\" CHECKIN $Date: 2002/07/04 11:45:55 $
+.\"
+.TH rcapid 8
+.SH NAME
+rcapid \- remote CAPI server
+.SH SYNOPSIS
+rcapid [-l loglevel]
+.SH DESCRIPTION
+.B rcapid
+is a server to communicate with CAPI clients.
+
+It is designed to run from inetd.
+
+add the following line to /etc/services:
+
+  capi 6000/tcp
+
+add the following line to /etc/inetd.conf:
+
+  capi stream tcp nowait.9999 /usr/sbin/rcapid rcapid
+
+(there's not much documentation to be found. help!)
+
+.SH OPTIONS
+.TP
+.BI "-l" " loglevel"
+the level of verbosity in the logging.
+This is logged in /tmp/rcapid.log
+
+.SH BUGS
+The logging should go through syslog.
+
+.SH AUTHOR
+manpage written from C source and README by Paul Slootman <paul at debian.org>.