Add manpages for eicon

Signed-off-by: Karsten Keil <kkeil@linux-pingi.de>
This commit is contained in:
Karsten Keil 2012-02-25 15:12:24 +01:00
parent 23066c5bda
commit eafe399e40
8 changed files with 528 additions and 5 deletions

View File

@ -16,7 +16,7 @@ DIVALOADPROGRAM = divaload
DIVALOGDPROGRAM = divalogd
DIVALOGPROGRAM = divalog
DIVAPROGRAMS = $(DIVALOADPROGRAM) $(DIVALOGDPROGRAM) $(DIVALOGPROGRAM)
MANPAGE = eiconctrl.8
MANPAGES = eiconctrl divaload divalog divalogd
INSTALL = @INSTALL@
CARDSBINDIR = @CONFIG_CARD_SBINDIR@
SBINDIR = @CONFIG_SBINDIR@
@ -94,9 +94,11 @@ install-data:
mkdir -p $(DESTDIR)$(DATA_DIR)
tar xpCfz $(DESTDIR)$(DATA_DIR) firmware/eicon_firm.tgz
install-man: $(PROGRAM).man
install-man: $(PROGRAM).man $(DIVALOADPROGRAM).man $(DIVALOGPROGRAM).man $(DIVALOGDPROGRAM).man
mkdir -p $(DESTDIR)$(MAN8DIR)
$(INSTALL_MAN) $< $(DESTDIR)$(MAN8DIR)/$(MANPAGE)
for i in $(MANPAGES); do \
$(INSTALL_MAN) $$i.man $(DESTDIR)$(MAN8DIR)/$$i.8; \
done
install: all install-man install-data
$(INSTALL_PROGRAM) $(PROGRAM) $(DESTDIR)$(CARDSBINDIR)/$(PROGRAM)
@ -115,7 +117,10 @@ ifeq ("@HAVE_NATIVE@","n")
endif
uninstall:
rm -f $(DESTDIR)$(CARDSBINDIR)/$(PROGRAM) $(DESTDIR)$(MAN8DIR)/$(MANPAGE)
for i in $(MANPAGES); do \
rm -f $(DESTDIR)$(MAN8DIR)/$$i.8; \
done
rm -f $(DESTDIR)$(CARDSBINDIR)/$(PROGRAM)
ifeq ("@HAVE_NATIVE@","n")
rm -f $(DESTDIR)$(CARDSBINDIR)/$(DIVALOADPROGRAM)
rm -f $(DESTDIR)$(SBINDIR)/$(DIVALOGDPROGRAM)

View File

@ -80,4 +80,4 @@ AC_SUBST(CONFIG_CARD_SBINDIR)
AC_SUBST(CONFIG_MANDIR)
AC_SUBST(I4LVERSION)
AC_CONFIG_HEADER(config.h)
AC_OUTPUT(Makefile eiconctrl.man)
AC_OUTPUT(Makefile eiconctrl.man divaload.man divalog.man divalogd.man)

186
eicon/divaload.man Normal file
View File

@ -0,0 +1,186 @@
.\" $Id: $
.\"
.\" CHECKIN $Date: $
.\"
.\" Process this file with
.\" groff -man -Tascii divaload.man for ASCII output, or
.\" groff -man -Tps divaload.man for PostScript output
.\"
.TH DIVALOAD 8 "2000/12/02" divaload "Linux System Administration"
.SH NAME
divaload \- configure Eicon Diva active ISDN card
.SH SYNOPSIS
divaload controller protocol [options]
.SH DESCRIPTION
.B divaload
is used to setup the Eicon Diva card for the proper configuration.
.SH OPTIONS
.TP
.BI controller
selects the controller (card). This can be either:
.br
.B -c n
.br
where
.B n
is the controller number, or
.br
.B -all
.br
to operate on all cards.
.TP
.BI protocol
can be one of the following:
.nf
-f 1TR6 Germany, old protocol for PABX................ PRI & BRI
-f ETSI DSS1, Europe (Germany, ...)................... PRI & BRI
-f FRANC VN3, France, old protocol for PABX............ PRI & BRI
-f BELG NET3, Belgien, old protocol for PABX.......... PRI & BRI
-f SWED DSS1 with CRC4 off, Sweden, Benelux........... PRI
-f NI NI1, NI2, North America, National ISDN........ PRI & BRI
-f 5ESS 5ESS, North America, AT&T..................... PRI & BRI
-f JAPAN Japan, INS-NET64.............................. PRI & BRI
-f ATEL ATEL, Australia, old TPH1962.................. PRI & BRI
-f US North America, Auto Detect.................... BRI
-f ITALY DSS1, Italy................................... PRI & BRI
-f TWAN DSS1, Taiwan.................................. PRI & BRI
-f AUSTRAL Australia, Microlink (TPH1962), On Ramp ETSI.. PRI & BRI
-f 4ESS_SDN 4ESS Software Defined Network................. PRI
-f 4ESS_SDS 4ESS Switched Digital Service................. PRI
-f 4ESS_LDS 4ESS Long Distance Service.................... PRI
-f 4ESS_MGC 4ESS Megacom.................................. PRI
-f 4ESS_MGI 4ESS Megacom International.................... PRI
-f HONGKONG Hongkong...................................... PRI & BRI
-f RBSCAS Robbed Bit Signaling, CAS..................... PRI
-f QSIG QSIG, Intra PABX link protocol................ PRI & BRI
.fi
.LP
The following options
may be given to
.BR divaload .
.TP
.BI "-e [" "1,2,3" ]
set Layer 1 framing on PRI Adapter
.LP
.RS
.B 1
- doubleframing (NO CRC4)
.br
.B 2
- multiframing (CRC4)
.br
.B 3
- autodetection
.RE
.TP
.BI -x
set PRI Adapter in NT mode;
default mode is TE
.TP
.BI -z
set PRI Adapter in High Impedance state
until first user application does request
interface activation
.TP
.BI "-l [" "1...30" ]
set starting channel number on PRI Adapter.
By default the allocation of channels is made
on a high-to-low basis.
By specifying -l you select a low-to-high
allocation policy (in addition)
.TP
.BI "-q [" "0..3" ]
select QSIG options
.LP
.RS
.B 0
- CR and CHI 2 Bytes long (default)
.br
.B 1
- CR 1 byte, CHI 2 bytes
.br
.B 2
- CR is 2 bytes, CHI is 1 byte
.br
.B 3
- CR and CHI 1 byte
.br
(CR - Call Reference, CHI - B-Channel Ident.)
.RE
.TP
.BI "-n [" "0...20" ]
select NT2 mode and default length of DIDN
(DIDN - Direct Inward Dial Number)
.TP
.BI -o
turn off order checking of information elements
.TP
.BI "-p [" "1,2" ]
establish a permanent connection
(e.g. leased line configuration)
.LP
.RS
.B 1
- TE <-> TE mode, structured line
.br
.B 2
- NT <-> TE mode, raw line
.RE
.TP
.BI "-s [" "0,1,2,3" ]
D-Channel Layer 2 activation policy on BRI Adapter
.LP
.RS
.B 0
- On demand
.br
.B 1
- Deactivation only by NT side, preferred, default
.br
.B 2
- Always active
.br
.B 3
- Always active, mode 2
.RE
.TP
.BI "-t [" "0...63" ]
specifies a fixed TEI value
(Default is a automatic TEI assignment)
.TP
.BI -u
select point to point mode on BRI Adapter;
uses default TEI '0',
NT2 mode is on
.TP
.BI "-[" "1...8" ]oad|osa|spid
BRI Adapter B-Channel options
Specify the Originating Address (OAD),
Originating Sub-address (OSA) and/or
Service Profile Identifier (SPID)
for each B-channel (1 or 2 by BRI, 1...8 by 4BRI)
.br
Example: -1oad 123456 -1spid 1234560001
.TP
.BI -d
display protocol options summary
.TP
.BI -w
select alternative protocol code directory.
.br
default directory: "/usr/share/isdn"
.TP
.BI "-h "\fRor\fB " -?"
help
.SH AUTHOR
manpage written from -h output by Paul Slootman <paul@debian.org>.

186
eicon/divaload.man.in Normal file
View File

@ -0,0 +1,186 @@
.\" $Id: $
.\"
.\" CHECKIN $Date: $
.\"
.\" Process this file with
.\" groff -man -Tascii divaload.man for ASCII output, or
.\" groff -man -Tps divaload.man for PostScript output
.\"
.TH DIVALOAD 8 "@MANDATE@" divaload "Linux System Administration"
.SH NAME
divaload \- configure Eicon Diva active ISDN card
.SH SYNOPSIS
divaload controller protocol [options]
.SH DESCRIPTION
.B divaload
is used to setup the Eicon Diva card for the proper configuration.
.SH OPTIONS
.TP
.BI controller
selects the controller (card). This can be either:
.br
.B -c n
.br
where
.B n
is the controller number, or
.br
.B -all
.br
to operate on all cards.
.TP
.BI protocol
can be one of the following:
.nf
-f 1TR6 Germany, old protocol for PABX................ PRI & BRI
-f ETSI DSS1, Europe (Germany, ...)................... PRI & BRI
-f FRANC VN3, France, old protocol for PABX............ PRI & BRI
-f BELG NET3, Belgien, old protocol for PABX.......... PRI & BRI
-f SWED DSS1 with CRC4 off, Sweden, Benelux........... PRI
-f NI NI1, NI2, North America, National ISDN........ PRI & BRI
-f 5ESS 5ESS, North America, AT&T..................... PRI & BRI
-f JAPAN Japan, INS-NET64.............................. PRI & BRI
-f ATEL ATEL, Australia, old TPH1962.................. PRI & BRI
-f US North America, Auto Detect.................... BRI
-f ITALY DSS1, Italy................................... PRI & BRI
-f TWAN DSS1, Taiwan.................................. PRI & BRI
-f AUSTRAL Australia, Microlink (TPH1962), On Ramp ETSI.. PRI & BRI
-f 4ESS_SDN 4ESS Software Defined Network................. PRI
-f 4ESS_SDS 4ESS Switched Digital Service................. PRI
-f 4ESS_LDS 4ESS Long Distance Service.................... PRI
-f 4ESS_MGC 4ESS Megacom.................................. PRI
-f 4ESS_MGI 4ESS Megacom International.................... PRI
-f HONGKONG Hongkong...................................... PRI & BRI
-f RBSCAS Robbed Bit Signaling, CAS..................... PRI
-f QSIG QSIG, Intra PABX link protocol................ PRI & BRI
.fi
.LP
The following options
may be given to
.BR divaload .
.TP
.BI "-e [" "1,2,3" ]
set Layer 1 framing on PRI Adapter
.LP
.RS
.B 1
- doubleframing (NO CRC4)
.br
.B 2
- multiframing (CRC4)
.br
.B 3
- autodetection
.RE
.TP
.BI -x
set PRI Adapter in NT mode;
default mode is TE
.TP
.BI -z
set PRI Adapter in High Impedance state
until first user application does request
interface activation
.TP
.BI "-l [" "1...30" ]
set starting channel number on PRI Adapter.
By default the allocation of channels is made
on a high-to-low basis.
By specifying -l you select a low-to-high
allocation policy (in addition)
.TP
.BI "-q [" "0..3" ]
select QSIG options
.LP
.RS
.B 0
- CR and CHI 2 Bytes long (default)
.br
.B 1
- CR 1 byte, CHI 2 bytes
.br
.B 2
- CR is 2 bytes, CHI is 1 byte
.br
.B 3
- CR and CHI 1 byte
.br
(CR - Call Reference, CHI - B-Channel Ident.)
.RE
.TP
.BI "-n [" "0...20" ]
select NT2 mode and default length of DIDN
(DIDN - Direct Inward Dial Number)
.TP
.BI -o
turn off order checking of information elements
.TP
.BI "-p [" "1,2" ]
establish a permanent connection
(e.g. leased line configuration)
.LP
.RS
.B 1
- TE <-> TE mode, structured line
.br
.B 2
- NT <-> TE mode, raw line
.RE
.TP
.BI "-s [" "0,1,2,3" ]
D-Channel Layer 2 activation policy on BRI Adapter
.LP
.RS
.B 0
- On demand
.br
.B 1
- Deactivation only by NT side, preferred, default
.br
.B 2
- Always active
.br
.B 3
- Always active, mode 2
.RE
.TP
.BI "-t [" "0...63" ]
specifies a fixed TEI value
(Default is a automatic TEI assignment)
.TP
.BI -u
select point to point mode on BRI Adapter;
uses default TEI '0',
NT2 mode is on
.TP
.BI "-[" "1...8" ]oad|osa|spid
BRI Adapter B-Channel options
Specify the Originating Address (OAD),
Originating Sub-address (OSA) and/or
Service Profile Identifier (SPID)
for each B-channel (1 or 2 by BRI, 1...8 by 4BRI)
.br
Example: -1oad 123456 -1spid 1234560001
.TP
.BI -d
display protocol options summary
.TP
.BI -w
select alternative protocol code directory.
.br
default directory: "/usr/share/isdn"
.TP
.BI "-h "\fRor\fB " -?"
help
.SH AUTHOR
manpage written from -h output by Paul Slootman <paul@debian.org>.

47
eicon/divalog.man Normal file
View File

@ -0,0 +1,47 @@
.\" $Id: $
.\"
.\" CHECKIN $Date: $
.\"
.\" Process this file with
.\" groff -man -Tascii divalog for ASCII output, or
.\" groff -man -Tps divalog for PostScript output
.\"
.TH DIVALOG 8 "2000/12/02" divalog "Linux System Administration"
.SH NAME
divalog \- Utility to read and translate messages from divalogd
.SH SYNOPSIS
divalog [-a N] [-z] [[-w] | [-f file] [-x] [-c] [-i]
.SH DESCRIPTION
.B divalog
is used to read and translate messages from divalogd.
.SH OPTIONS
.TP
.BI "-a" " N"
to specify adapter number (N defaults to 1)
.TP
.BI -z
to clear log of all entries
.TP
.BI -w
to wait for entries to be logged
.TP
.BI -f
file to log to specified file
.TP
.BI -x
read ISDN trace
.TP
.BI -c
read CAPI trace
.TP
.BI -i
read IDI trace
.SH AUTHOR
manpage written from usage output by Paul Slootman <paul@debian.org>.

47
eicon/divalog.man.in Normal file
View File

@ -0,0 +1,47 @@
.\" $Id: $
.\"
.\" CHECKIN $Date: $
.\"
.\" Process this file with
.\" groff -man -Tascii divalog for ASCII output, or
.\" groff -man -Tps divalog for PostScript output
.\"
.TH DIVALOG 8 "@MANDATE@" divalog "Linux System Administration"
.SH NAME
divalog \- Utility to read and translate messages from divalogd
.SH SYNOPSIS
divalog [-a N] [-z] [[-w] | [-f file] [-x] [-c] [-i]
.SH DESCRIPTION
.B divalog
is used to read and translate messages from divalogd.
.SH OPTIONS
.TP
.BI "-a" " N"
to specify adapter number (N defaults to 1)
.TP
.BI -z
to clear log of all entries
.TP
.BI -w
to wait for entries to be logged
.TP
.BI -f
file to log to specified file
.TP
.BI -x
read ISDN trace
.TP
.BI -c
read CAPI trace
.TP
.BI -i
read IDI trace
.SH AUTHOR
manpage written from usage output by Paul Slootman <paul@debian.org>.

26
eicon/divalogd.man Normal file
View File

@ -0,0 +1,26 @@
.\" $Id: $
.\"
.\" CHECKIN $Date: $
.\"
.\" Process this file with
.\" groff -man -Tascii divalog for ASCII output, or
.\" groff -man -Tps divalog for PostScript output
.\"
.TH DIVALOGD 8 "2000/12/02" divalogd "Linux System Administration"
.SH NAME
divalogd \- utility to record messages from Diva cards
.SH SYNOPSIS
divalogd [ num ]
.SH DESCRIPTION
.B divalogd
connects to a logging device (/dev/Divas)
to receive messages form Diva cards, which
may assist in debugging problems etc.
.SH OPTIONS
.TP
.BI num
number of entries in the buffer. It must be between 10 and 100000.
Default is 1024.
.SH AUTHOR
manpage written from usage output by Paul Slootman <paul@debian.org>.

26
eicon/divalogd.man.in Normal file
View File

@ -0,0 +1,26 @@
.\" $Id: $
.\"
.\" CHECKIN $Date: $
.\"
.\" Process this file with
.\" groff -man -Tascii divalog for ASCII output, or
.\" groff -man -Tps divalog for PostScript output
.\"
.TH DIVALOGD 8 "@MANDATE@" divalogd "Linux System Administration"
.SH NAME
divalogd \- utility to record messages from Diva cards
.SH SYNOPSIS
divalogd [ num ]
.SH DESCRIPTION
.B divalogd
connects to a logging device (/dev/Divas)
to receive messages form Diva cards, which
may assist in debugging problems etc.
.SH OPTIONS
.TP
.BI num
number of entries in the buffer. It must be between 10 and 100000.
Default is 1024.
.SH AUTHOR
manpage written from usage output by Paul Slootman <paul@debian.org>.