1CONMAN.CONF(5) LLNL CONMAN.CONF(5)
3
7 conman.conf - ConMan daemon configuration file
8
11 The conman.conf configuration file is used to specify the consoles
12 being managed by conmand.
13 Comments are introduced by a hash sign (#), and continue until the end
15 of the line. Blank lines and white-space are ignored. Directives are
16 terminated by a newline, but may span multiple lines by escaping it
17 (ie, immediately preceding the newline with a backslash). Strings may
18 be either single-quoted or double-quoted, but they may not contain new‐
19 lines. Keywords are case-insensitive.
20
23 These directives begin with the SERVER keyword followed by one of the
24 following key/value pairs:
25 keepalive = (on|off)
27 Specifies whether the daemon will use TCP keep-alives for
28 detecting dead connections. The default is on.
29 logdir = "directory"
31 Specifies a directory prefix for log files that are not defined
32 via an absolute pathname.
33 logfile = "file[,priority]"
35 Specifies the file to which log messages are appended. This
36 string undergoes conversion specifier expansion (cf, CONVERSION
37 SPECIFICATIONS). If an absolute pathname is not specified, the
38 file's location is relative to logdir (assuming it has been pre‐
39 viously defined). This file will be created if it does not
40 already exist. The filename may optionally be followed by a
41 comma and a minimum priority at which messages will be logged.
42 Refer to syslog.conf(5) for a list of priorities. The default
43 priority is info. If this keyword is used in conjunction with
44 the syslog keyword, messages will be sent to both locations.
45 loopback = (on|off)
47 Specifies whether the daemon will bind its socket to the loop‐
48 back address, thereby only accepting local client connections
49 directed to that address (127.0.0.1). The default is off.
50 pidfile = "file"
52 Specifies the file to which the daemon's PID is written. The
53 use of a pidfile is recommended if you want to use the daemon's
54 '-k', '-q', or '-r' options.
55 port = integer
57 Specifies the port on which the daemon will listen for client
58 connections.
59 resetcmd = "string"
61 Specifies a command string to be invoked by a subshell upon
62 receipt of the client's "reset" escape. Multiple commands
63 within a string may be separated with semicolons. This string
64 undergoes conversion specifier expansion (cf, CONVERSION SPECI‐
65 FICATIONS) and will be invoked multiple times if the client is
66 connected to multiple consoles.
67 syslog = "facility"
69 Specifies that log messages are to be sent to the system logger
70 (syslogd) at the given facility. Refer to syslog.conf(5) for a
71 list of facilities. If this keyword is used in conjunction with
72 the logfile keyword, messages will be sent to both locations.
73 tcpwrappers = (on|off)
75 Specifies whether the daemon will use TCP-Wrappers when accept‐
76 ing client connections. Support for this feature must be
77 enabled at compile-time (via configure's "--with-tcp-wrappers"
78 option). Refer to hosts_access(5) and hosts_options(5) for more
79 details. The default is off.
80 timestamp = integer (m|h|d)
82 Specifies the interval between timestamps written to the indi‐
83 vidual console log files. The interval is an integer that may
84 be followed by a single-character modifier; 'm' for minutes (the
85 default), 'h' for hours, or 'd' for days. The default is 0 (ie,
86 no timestamps).
87
90 These directives begin with the GLOBAL keyword followed by one of the
91 following key/value pairs:
92 log = "file"
94 Specifies the default log file to use for each console direc‐
95 tive. This string undergoes conversion specifier expansion (cf,
96 CONVERSION SPECIFICATIONS) and must contain either '%N' or '%D'.
97 If an absolute pathname is not given, the file's location is
98 relative to logdir (assuming it has been previously defined).
99 logopts = "(sanitize|nosanitize),(timestamp|notimestamp)"
101 Specifies global options for the console log files. These
102 options can be overridden on an per-console basis by specifying
103 the CONSOLE logopts keyword. Note that options affecting the
104 output of the console's logfile also affect the output of the
105 console's log-replay escape. The valid logoptions include the
106 following:
107 sanitize or nosanitize - sanitized log files convert non-print‐
109 able characters into 7-bit printable characters.
110 timestamp or notimestamp - timestamped logs prepend each line of
112 console output with a timestamp in "YYYY-MM-DD HH:MM:SS" format.
113 This timestamp is generated when the first character following
114 the line break is output.
115 The default is "nosanitize,notimestamp".
117 seropts = "bps[,databits[parity[stopbits]]]"
119 Specifies global options for local serial devices. These
120 options can be overridden on an per-console basis by specifying
121 the CONSOLE seropts keyword.
122 bps is an integer specifying the baud rate in bits-per-second.
124 If this exact value is not supported by the system, it will be
125 rounded down to the next supported value.
126 databits is an integer from 5-8.
128 parity is a single case-insensitive character: 'n' for none, 'o'
130 for odd, and 'e' for even.
131 stopbits is an integer from 1-2.
133 The default is "9600,8n1" for 9600 bps, 8 data bits, no parity,
135 and 1 stop bit.
136
139 This directive defines an individual console being managed by the dae‐
140 mon. The CONSOLE keyword is followed by one or more of the following
141 key/value pairs:
142 name = "string"
144 Specifies the name used by clients to refer to the console.
145 This keyword is required.
146 dev = "string"
148 Specifies the location of the device. A local serial-port con‐
149 nection is specified with the pathname of the tty device. A
150 remote terminal-server connection is specified with the
151 "host:port" format (where host is either a hostname or IP
152 address). This keyword is required.
153 log = "file"
155 Specifies the file where console output is logged. This string
156 undergoes conversion specifier expansion (cf, CONVERSION SPECI‐
157 FICATIONS). If an absolute pathname is not given, the file's
158 location is relative to logdir (assuming it has been previously
159 defined). An empty log string (ie, log="") disables logging,
160 overriding the global log name.
161 logopts = "string"
163 This keyword is optional (cf, GLOBAL DIRECTIVES).
164 seropts = "string"
166 This keyword is optional (cf, GLOBAL DIRECTIVES).
167
170 A conversion specifier is a two-character sequence beginning with a '%'
171 character. The second character in the sequence specifies the type of
172 conversion to be applied. The following specifiers are supported:
173 %N The console name (from the name string).
175 %D The console device basename (from the dev string), with leading
177 directory components removed.
178 %P The daemon's process identifier.
180 %Y The year as a 4-digit number with the century.
182 %y The year as a 2-digit number without the century.
184 %m The month as a 2-digit number (01-12).
186 %d The day of the month as a 2-digit number (01-31).
188 %H The hour as a 2-digit number using a 24-hour clock (00-23).
190 %M The minute as a 2-digit number (00-59).
192 %S The seconds as a 2-digit number (00-61).
194 %s The number of seconds since the Epoch.
196 %% A literal '%' character.
198 The console name (%N) and device (%D) specifiers are "sanitized" in
200 that non-printable characters and the forward-slash (/) character are
201 replaced with underscores.
202
205 /etc/conman.conf
206
209 Chris Dunlap <cdunlap@llnl.gov>
210
213 Copyright (C) 2001-2006 by the Regents of the University of California.
214 Produced at Lawrence Livermore National Laboratory. UCRL-
215 CODE-2002-009.
216 ConMan is free software; you can redistribute it and/or modify it under
218 the terms of the GNU General Public License as published by the Free
219 Software Foundation.
220
223 conman(1), conmand(8).
224 The ConMan FTP site:
226 ftp://ftp.llnl.gov/pub/linux/conman/
227 The ConMan Web page:
229 http://www.llnl.gov/linux/conman/
230conman-0.1.9.2 2006-06-26 CONMAN.CONF(5)