Initial implementation of doc/pattyd.conf.5
Add doc/pattyd.conf.5 to document the pattyd configuration file format
This commit is contained in:
parent
db9078e1d2
commit
34b854c6cc
3 changed files with 72 additions and 0 deletions
1
Makefile
1
Makefile
|
@ -6,6 +6,7 @@ all:
|
||||||
install:
|
install:
|
||||||
$(MAKE) -C src install
|
$(MAKE) -C src install
|
||||||
$(MAKE) -C bin install
|
$(MAKE) -C bin install
|
||||||
|
$(MAKE) -C doc install
|
||||||
|
|
||||||
clean:
|
clean:
|
||||||
$(MAKE) -C src clean
|
$(MAKE) -C src clean
|
||||||
|
|
11
doc/Makefile
Normal file
11
doc/Makefile
Normal file
|
@ -0,0 +1,11 @@
|
||||||
|
include ../mk/build.mk
|
||||||
|
|
||||||
|
CC = $(CROSS)cc
|
||||||
|
|
||||||
|
MANPAGES = pattyd.conf.5
|
||||||
|
|
||||||
|
all: $(MANPAGES)
|
||||||
|
|
||||||
|
install: $(MANPAGES)
|
||||||
|
$(INSTALL) -d -m 0755 $(MANDIR)/man5
|
||||||
|
$(INSTALL) -c -m 0644 pattyd.conf.5 $(MANDIR)/man5
|
60
doc/pattyd.conf.5
Normal file
60
doc/pattyd.conf.5
Normal file
|
@ -0,0 +1,60 @@
|
||||||
|
.Dd $Mdocdate$
|
||||||
|
.Dt PATTYD 8
|
||||||
|
.Os
|
||||||
|
.Sh NAME
|
||||||
|
.Nm pattyd.conf
|
||||||
|
.Nd AX.25 daemon configuration file
|
||||||
|
.Sh DESCRIPTION
|
||||||
|
The
|
||||||
|
.Nm
|
||||||
|
file contains AX.25 network interface declarations, static routes, and daemon
|
||||||
|
settings for
|
||||||
|
.Xr pattyd 8 ,
|
||||||
|
the AX.25 userland stack daemon.
|
||||||
|
.Pp
|
||||||
|
The
|
||||||
|
.Nm
|
||||||
|
file is a line-oriented configuration file, with
|
||||||
|
.Xr sh 1
|
||||||
|
style string quotation and backslash escapes. The following declarations are
|
||||||
|
supported.
|
||||||
|
.Bl -tag -width Ds
|
||||||
|
.It Li sock Ar patty.sock
|
||||||
|
Specify the path of a Unix domain socket for
|
||||||
|
.Xr pattyd 8
|
||||||
|
to listen for client connections on.
|
||||||
|
.It Li pid Ar /var/run/patty.pid
|
||||||
|
Specify the path of a regular file to write the process ID of
|
||||||
|
.Xr pattyd 8
|
||||||
|
to, when run in forking daemon mode.
|
||||||
|
.It Li if Ar ifname Li ax25 Ar MYCALL Li kiss Ar /dev/ttyXYZ Op tioargs ...
|
||||||
|
Raise an interface named
|
||||||
|
.Ar ifname ,
|
||||||
|
with the callsign
|
||||||
|
.Ar MYCALL
|
||||||
|
attached to the character device
|
||||||
|
.Ar /dev/ttyXYZ ,
|
||||||
|
with the optional
|
||||||
|
.Op tioargs
|
||||||
|
as follows:
|
||||||
|
.Bl -tag
|
||||||
|
.It Li baud Ar rate
|
||||||
|
.It Li flow Ar crtscts
|
||||||
|
.It Li flow Ar xonxoff
|
||||||
|
.El
|
||||||
|
.It Li route station Ar CALLSGN Li if Ar ifname Li path Ar HOP1 Op ...
|
||||||
|
Add a static route to reach
|
||||||
|
.Ar CALLSGN
|
||||||
|
via interface
|
||||||
|
.Ar ifname ,
|
||||||
|
repeated by
|
||||||
|
.Ar HOP1
|
||||||
|
.Op ... .
|
||||||
|
.It Li route default if Ar ifname
|
||||||
|
Set the interface
|
||||||
|
.Ar ifname
|
||||||
|
as the interface used to send packets from by default, when no other static
|
||||||
|
routes exist to reach a given destination.
|
||||||
|
.El
|
||||||
|
.Sh AUTHORS
|
||||||
|
.An XANTRONIX Development Aq Mt dev@xantronix.com
|
Loading…
Add table
Reference in a new issue