1NODE.CONF(5) Linux Programmer's Manual NODE.CONF(5)
2
6 node.conf - LinuxNode configuration file.
7
9 Node.conf file is read by LinuxNode at program startup and is used to
10 modify the behaviour of the node.
11 The lines within node.conf must either be a comment line, which starts
13 with a # in the first column, or one of the commands listed below. Com‐
14 mands and arguments are delimited by white space. Arguments can contain
15 white space if they are enclosed in single or double quotes. C style
16 character literals are not parsed and parameter expansion (see below)
17 is not done inside single quotes.
18 Available configuration commands are:
20 Alias <NAme> '<command> [<args...>]'
22 Sets up a command alias. The number of uppercase charac‐
23 ters at the beginning of <NAme> specifies how much the
24 user may abbreviate the command. The uppercase part
25 should be long enough to separate the command from other
26 commands starting with the same letters. If there are no
27 uppercase letters in the beginning, the whole name is
28 converted to upper case and user can not abbreviate the
29 command. Note that certain %-escapes (positional parame‐
30 ters, current time) have a reasonable meaning only when
31 the alias is actually executed and thus they should not
32 be parsed at the time the configuration file is read.
33 This can be achieved by enclosing the command and argu‐
34 ment part in single quotes. Another possibility is to use
35 double quotes and escape the percent sign with a back‐
36 slash (eg. \%1)
37 ConnTimeout <timeout>
39 When user is connected to another system via this system
40 and the connection is idle (no data flowing in either
41 direction) for <timeout> seconds the connection is
42 dropped and user disconnected from node. Default is 3600
43 seconds (1 hour).
44 EscapeChar <escape string>
46 Specifies the escape character. The escape string may be
47 specified using any of the well known codings:
48 <char> to enter the escape character in its binary form.
50 ^C to enter the escape character as a control character
52 value.
53 NNN to set the escape character to a Decimal value.
55 0xNN to set the escape character to a HexaDecimal value.
57 0NNN to set the escape character to an Octal value.
59 off to disable the escape character.
61 The default is CTRL-T (^T).
63 Note that the escape mechanism breaks 8-bit transparency
65 of LinuxNode and you should either disable it or set the
66 no-escape flag in node.perms for the forwarding stations
67 if (compressed) forward is run trough LinuxNode. Also the
68 Escape user command can be used in a forward script to
69 disable the escape (see node(8)).
70 ExtCmd <NAme> <flags> <uid> <exec> <args...>
72 Sets up an external command.
73 NAme This is the name under which the command
75 appears at nodes command list. The number of
76 uppercase characters at the beginning of <NAme>
77 specifies how much the user may abbreviate the
78 command. The uppercase part should be long
79 enough to separate the command from other com‐
80 mands starting with the same letters. If there
81 are no uppercase letters in the beginning, the
82 whole name is converted to upper case and user
83 can not abbreviate the command.
84 flags This is a sum of flags that control the way the
86 external command is executed. Currently two
87 flags are implemented:
88 1 Run command through pipe. Without this
90 flag node just fork()s and exec()s the
91 specified command and then waits for it to
92 terminate. The command must it self be
93 aware about the underlying protocol. It
94 must handle packetising and any end of
95 line conversions. With this flag however
96 node sets up a pipe between it self and
97 the command and handles packetising and
98 end of line conversions for it.
99 2 Reconnected to flag. If this flag is set,
101 the user gets a reconnected to prompt
102 after the external command is finished.
103 uid This is the userid that the following command
105 should run under when executing.
106 exec This is the executable that should be executed.
108 args... These are the optional arguments that are
110 passed to the executable. The first argument
111 is the command name that is passed to the pro‐
112 gram (argv[0]). It is usually the executable
113 name without path. See the Alias command for a
114 discussion about the command arguments and
115 %-escapes (parameter expansion).
116 HiddenPorts <portname> ...
118 Marks the AX.25 port <portname> as hidden. Hidden ports
119 are not shown to users in Links, Mheard, Ports and Routes
120 commands and can not be used to make AX.25 downlink con‐
121 nections unless user is specially permitted to do so (see
122 node.perms(5)). Up to 32 hidden ports can be specified
123 with this command.
124 HostName <hostname>
126 This is the visible hostname of the node. It will be
127 shown at telnet login and in the node welcome message.
128 IdleTimeout <timeout>
130 After <timeout> seconds of inactivity while waiting for a
131 command user is disconnected from node. Default is 900
132 seconds (15 mins).
133 LocalNet <network>
135 Defines a "local" network. Users telneting from hosts in
136 this network are treated separately (see node.perms(5)).
137 <network> is a KA9Q NOS style network address consisting
138 of a dotted-quad IP address of the network and a number
139 of significant bits separated by a slash. Note that
140 127.0.0.0/8 (loopback net) is also considered "local" by
141 default.
142 LogLevel <loglevel>
144 Specifies what node should log. The available levels are:
145 0 Don't log anything.
147 1 Log only critical errors.
149 2 Log errors and logins/logouts.
151 3 Log errors, logins/logouts and all gateway commands.
153 Default is to log only critical errors.
155 NodeId <id> This is the id that is shown in every message from node.
157 Default is "LinuxNode}".
158 NodePrompt <prompt>
160 Sets the prompt string. The prompt string is evaluated
161 every time it is printed so what was previously said
162 about %-escapes (parameter expansion) in Alias command is
163 valid here also.
164 NrPort <portname>
166 This is the name of the netrom port that is used when
167 making outgoing netrom connects. Normally it should match
168 the portname that is used in ax25d.conf to listen for
169 incoming netrom calls. Default is the first netrom port.
170 ReConnect on|off
172 ReConnect flag. If enabled, users gatewaying to another
173 host get reconnected to this node after the remote host
174 closes connection. If it's off connection to the user
175 will also be closed. User can override the default behav‐
176 iour with a single `s' or `d' at the end of the gateway‐
177 ing command (connect or telnet). Default is off.
178 ResolveAddrs on|off
180 If enabled, dotted-quad IP addresses are resolved to sym‐
181 bolic names when pinging or telneting out. Also, the
182 domain name of the peer is resolved for telnet logins.
183 Default is off.
184
186 C style character literals are parsed when reading the configuration
187 file. The following formats are expanded:
188 \n This is substituted with Line Feed
190 \t This is substituted with Horizontal Tab
192 \v This is substituted with Vertical Tab
194 \b This is substituted with Backspace
196 \r This is substituted with Carriage Return
198 \f This is substituted with Form Feed
200 \a This is substituted with Alert (BELL)
202 \\ This is substituted with Backslash (\)
204 \" This is substituted with double quote (")
206 \' This is substituted with single quote (')
208 \xNN This is substituted with the character corresponding to
210 the code value of NN interpreted as a hexadecimal number.
211 \0NN This is substituted with the character corresponding to
213 the code value of NN interpreted as an octal number.
214 \0 This is substituted with the NUL character (ascii 0)
216
218 While reading the configuration file a word starting with a % is
219 expanded. The following formats are expanded:
220 %parameter This is substituted with the value of parameter
222 %{parameter} The same as above.
224 %{parameter:default}
226 If parameter is defined this is susbtituted with the
227 value of it. If not, the default value is substituted.
228 This currently applies only to positional parameters
229 0...9.
230 The following parameters are defined:
232 0...9 The positional parameters. Positional parameters are not mean‐
234 ingful while reading the node.conf so the default value (if
235 present) is always substituted.
236 F The full hostname in upper case.
238 f The full hostname in lower case.
240 H The hostname in upper case.
242 h The hostname in lower case.
244 I or i Current time (HH:MM:SS).
246 N or n The node ID as set with the NodeId command.
248 U The username (callsign) of the remote station in upper case
250 without the SSID.
251 u The username (callsign) of the remote station in lower case
253 without the SSID.
254 S The username (callsign) of the remote station in upper case
256 with the SSID.
257 s The username (callsign) of the remote station in lower case
259 with the SSID.
260 P The nodename (callsign) of the remote station (NET/ROM), the
262 portname the user is coming in via (AX.25) or the ip address of
263 the remote host (TCP). In upper case without the SSID.
264 p The nodename (callsign) of the remote station (NET/ROM), the
266 portname the user is coming in via (AX.25) or the ip address of
267 the remote host (TCP). In lower case without the SSID.
268 R The nodename (callsign) of the remote station (NET/ROM), the
270 portname the user is coming in via (AX.25) or the ip address of
271 the remote host (TCP). In upper case with the SSID.
272 r The nodename (callsign) of the remote station (NET/ROM), the
274 portname the user is coming in via (AX.25) or the ip address of
275 the remote host (TCP). In lower case with the SSID.
276 t The type of the user connection (ax25, netrom, rose, inet,
278 host) in lower case.
279 T The type of the user connection (ax25, netrom, rose, inet,
281 host) in upper case.
282 Anything else after a % is substituted with a %.
284
286 /etc/ax25/node.conf
287
289 node(8), node.perms(5), axports(5), ax25(4).
290Linux 16 June 1999 NODE.CONF(5)