.TH NODE.CONF 5 "16 June 1999" Linux "Linux Programmer's Manual"
.SH NAME
node.conf \- LinuxNode configuration file.
.SH DESCRIPTION
.LP
.B Node.conf
file is read by LinuxNode at program startup and is used to modify the
behaviour of the node.
.LP
The lines within
.B node.conf
must either be a comment line, which starts with a # in the first column, or
one of the commands listed below. Commands and arguments are delimited
by white space. Arguments can contain white space if they are enclosed
in single or double quotes. C style character literals are not parsed and
parameter expansion (see below) is not done inside single quotes.
.sp
Available configuration commands are:
.TP 14
.B Alias <NAme> '<command> [<args...>]'
Sets up a command alias. The number of uppercase characters at the
beginning of <NAme> specifies how much the user may abbreviate the
command. The uppercase part should be long enough to separate the command
from other commands starting with the same letters. If there are no
uppercase letters in the beginning, the whole name is converted to upper
case and user can not abbreviate the command. Note that certain %-escapes
(positional parameters, current time) have a reasonable meaning only when
the alias is actually executed and thus they should not be parsed at the
time the configuration file is read. This can be achieved by enclosing
the command and argument part in single quotes. Another possibility is
to use double quotes and escape the percent sign with a backslash (eg. \\%1)
.TP 14
.B ConnTimeout <timeout>
When user is connected to another system via this system and the
connection is idle (no data flowing in either direction) for <timeout>
seconds the connection is dropped and user disconnected from node.
Default is 3600 seconds
(1 hour).
.TP 14
.B EscapeChar <escape string>
Specifies the escape character.
The escape string may be specified using any of the
well known codings:
.IP
.BI "<char>"
to enter the escape character in its binary form.
.IP
.BI "^C"
to enter the escape character as a control character value.
.IP
.BI "NNN"
to set the escape character to a Decimal value.
.IP
.BI "0xNN"
to set the escape character to a HexaDecimal value.
.IP
.BI "0NNN"
to set the escape character to an Octal value.
.IP
.BI "off"
to disable the escape character.
.sp
The default is CTRL-T (^T).
.sp
Note that the escape mechanism breaks 8-bit transparency of LinuxNode
and you should either disable it or set the no-escape flag in node.perms
for the forwarding stations if (compressed) forward is run trough
LinuxNode. Also the Escape user command can be used in a forward script
to disable the escape (see node(8)).
.TP 14
.B ExtCmd <NAme> <flags> <uid> <exec> <args...>
Sets up an external command.
.RS
.TP 10
.B NAme
This is the name under which the command appears at nodes command list.
The number of uppercase characters at the beginning of <NAme> specifies
how much the user may abbreviate the command.
The uppercase part should be long enough to separate the command
from other commands starting with the same letters. If there are no
uppercase letters in the beginning, the whole name is converted to upper
case and user can not abbreviate the command.
.TP 10
.B flags
This is a sum of flags that control the way the external
command is executed. Currently two flags are implemented:
.RS
.TP 5
.B 1
Run command through pipe. Without this flag node just fork()s and exec()s
the specified command and then waits for it to terminate. The command must
it self be aware about the underlying protocol. It must handle packetising
and any end of line conversions. With this flag however node sets up a pipe
between it self and the command and handles packetising and end of line
conversions for it.
.TP 5
.B 2
Reconnected to flag. If this flag is set, the user gets a reconnected to
prompt after the external command is finished.
.RE
.TP 10
.B uid
This is the userid that the following command should run under when
executing.
.TP 10
.B exec
This is the executable that should be executed.
.TP 10
.B args...
These are the optional arguments that are passed to the executable.
The first argument is the command name that is passed to the program
(argv[0]). It is usually the executable name without path.
See the Alias command for a discussion about the command arguments
and %-escapes (parameter expansion).
.RE
.TP 14
.B HiddenPorts <portname> ...
Marks the AX.25 port <portname> as hidden. Hidden ports are not shown
to users in
Links, Mheard, Ports and Routes commands and can not be used to make
AX.25 downlink connections unless user is specially permitted to do
so (see node.perms(5)). Up to 32 hidden ports can be specified with
this command.
.TP 14
.B HostName <hostname>
This is the visible hostname of the node. It will be shown at telnet
login and in the node welcome message.
.TP 14
.B IdleTimeout <timeout>
After <timeout> seconds of inactivity while waiting for a command user
is disconnected from node. Default is 900 seconds (15 mins).
.TP 14
.B LocalNet <network>
Defines a "local" network. Users telneting from hosts in this network
are treated separately (see node.perms(5)). <network> is a KA9Q NOS
style network address consisting of a dotted-quad IP address of the
network and a number of significant bits separated by a slash. Note
that 127.0.0.0/8 (loopback net) is also considered "local" by default.
.TP 14
.B LogLevel <loglevel>
Specifies what node should log. The available levels are:
.RS
.TP 5
.B 0
Don't log anything.
.TP 5
.B 1
Log only critical errors.
.TP 5
.B 2
Log errors and logins/logouts.
.TP 5
.B 3
Log errors, logins/logouts and all gateway commands.
.LP
Default is to log only critical errors.
.RE
.TP 14
.B NodeId <id>
This is the id that is shown in every message from node. Default
is "LinuxNode}".
.TP 14
.B NodePrompt <prompt>
Sets the prompt string. The prompt string is evaluated every time it is
printed so what was previously said about %-escapes (parameter expansion)
in Alias command is valid here also.
.TP 14
.B NrPort <portname>
This is the name of the netrom port that is used when making outgoing
netrom connects. Normally it should match the portname that is used
in ax25d.conf to listen for incoming netrom calls. Default is the first
netrom port.
.TP 14
.B ReConnect on|off
ReConnect flag. If enabled, users gatewaying to another host
get reconnected to this node after the remote host closes connection.
If it's off connection to the user will also be closed. User can
override the default behaviour with a single `s' or `d' at the end
of the gatewaying command (connect or telnet).
Default is off.
.TP 14
.B ResolveAddrs on|off
If enabled, dotted-quad IP addresses are resolved to symbolic names
when pinging or telneting out. Also, the domain name of the peer is
resolved for telnet logins.
Default is off.
.SH CHARACTER LITERALS
.LP
C style character literals are parsed when reading the configuration file.
The following formats are expanded:
.TP 14
\\n
This is substituted with Line Feed
.TP 14
\\t
This is substituted with Horizontal Tab
.TP 14
\\v
This is substituted with Vertical Tab
.TP 14
\\b
This is substituted with Backspace
.TP 14
\\r
This is substituted with Carriage Return
.TP 14
\\f
This is substituted with Form Feed
.TP 14
\\a
This is substituted with Alert (BELL)
.TP 14
\\\\
This is substituted with Backslash (\\)
.TP 14
\\"
This is substituted with double quote (")
.TP 14
\\'
This is substituted with single quote (')
.TP 14
\\xNN
This is substituted with the character corresponding to the code value
of NN interpreted as a hexadecimal number.
.TP 14
\\0NN
This is substituted with the character corresponding to the code value
of NN interpreted as an octal number.
.TP 14
\\0
This is substituted with the NUL character (ascii 0)
.SH PARAMETER EXPANSION
.LP
While reading the configuration file a word starting with a % is
expanded. The following formats are expanded:
.TP 14
.B %parameter
This is substituted with the value of
.B parameter
.
.TP 14
.B %{parameter}
The same as above.
.TP 14
.B %{parameter:default}
If
.B parameter
is defined this is susbtituted with the value of it. If not, the default
value is substituted. This currently applies only to positional parameters
0...9.
.LP
The following parameters are defined:
.LP
.TP 8
.B 0...9
The positional parameters. Positional parameters are not meaningful
while reading the node.conf so the default value (if present) is always
substituted.
.TP 8
.B F
The full hostname in upper case.
.TP 8
.B f
The full hostname in lower case.
.TP 8
.B H
The hostname in upper case.
.TP 8
.B h
The hostname in lower case.
.TP 8
.B I or i
Current time (HH:MM:SS).
.TP 8
.B N or n
The node ID as set with the NodeId command.
.TP 8
.B U
The username (callsign) of the remote station in upper case without the SSID.
.TP 8
.B u
The username (callsign) of the remote station in lower case without the SSID.
.TP 8
.B S
The username (callsign) of the remote station in upper case with the SSID.
.TP 8
.B s
The username (callsign) of the remote station in lower case with the SSID.
.TP 8
.B P
The nodename (callsign) of the remote station (NET/ROM), the portname the
user is coming in via (AX.25) or the ip address of the remote host (TCP).
In upper case without the SSID.
.TP 8
.B p
The nodename (callsign) of the remote station (NET/ROM), the portname the
user is coming in via (AX.25) or the ip address of the remote host (TCP).
In lower case without the SSID.
.TP 8
.B R
The nodename (callsign) of the remote station (NET/ROM), the portname the
user is coming in via (AX.25) or the ip address of the remote host (TCP).
In upper case with the SSID.
.TP 8
.B r
The nodename (callsign) of the remote station (NET/ROM), the portname the
user is coming in via (AX.25) or the ip address of the remote host (TCP).
In lower case with the SSID.
.TP 8
.B t
The type of the user connection (ax25, netrom, rose, inet, host) in lower case.
.TP 8
.B T
The type of the user connection (ax25, netrom, rose, inet, host) in upper case.
.LP
Anything else after a % is substituted with a %.
.SH FILES
.LP
/etc/ax25/node.conf
.SH "SEE ALSO"
.BR node (8),
.BR node.perms (5),
.BR axports (5),
.BR ax25 (4).