1CONMAN(1) ConMan: The Console Manager CONMAN(1)
2
3
4
6 conman - ConMan client
7
8
10 conman [OPTION]... [CONSOLE]...
11
12
14 conman is a program for connecting to remote consoles being managed by
15 conmand. Console names can be separated by spaces and/or commas.
16 Globbing is used by default to match console names against the configu‐
17 ration, but regular expression matching can be enabled with the '-r'
18 option.
19
20 conman supports three modes of console access: monitor (read-only),
21 interactive (read-write), and broadcast (write-only). If neither the
22 '-m' (monitor) nor '-b' (broadcast) options are specified, the console
23 session is opened in interactive mode.
24
25
27 -b Broadcast to multiple consoles (write-only). Data sent by the
28 client will be copied to all specified consoles in parallel, but
29 console output will not be sent back to the client. This option
30 can be used in conjunction with '-f' or '-j'.
31
32 -d destination
33 Specify the location of the conmand daemon, overriding the
34 default [127.0.0.1:7890]. This location may contain a hostname
35 or IP address, and be optionally followed by a colon and port
36 number.
37
38 -e character
39 Specify the client escape character, overriding the default [&].
40
41 -f Specify that write-access to the console should be "forced",
42 thereby stealing the console away from existing clients having
43 write privileges. The original clients are informed by conmand
44 of who perpetrated the theft as their connections are termi‐
45 nated.
46
47 -F file
48 Read console names/patterns from file. Only one console name
49 may be specified per line. Leading and trailing whitespace,
50 blank lines, and comments (i.e., lines beginning with a '#') are
51 ignored.
52
53 -h Display a summary of the command-line options.
54
55 -j Specify that write-access to the console should be "joined",
56 thereby sharing the console with existing clients having write
57 privileges. The original clients are informed by conmand that a
58 new client has been granted write privileges.
59
60 -l file
61 Log console session output to file.
62
63 -L Display license information.
64
65 -m Monitor a console (read-only).
66
67 -q Query conmand for consoles matching the specified names/pat‐
68 terns. Output from this query can be saved to file for use with
69 the '-F' option.
70
71 -Q Enable quiet-mode, suppressing informational messages. This
72 mode can be toggled within a console session via the '&Q'
73 escape.
74
75 -r Match console names via regular expressions instead of globbing.
76
77 -v Enable verbose mode.
78
79 -V Display version information.
80
81
83 The following escapes are supported and assume the default escape char‐
84 acter [&]:
85
86 &? Display a list of currently available escapes.
87
88 &. Terminate the connection.
89
90 && Send a single escape character.
91
92 &B Send a "serial-break" to the remote console.
93
94 &E Toggle echoing of client input.
95
96 &F Switch from read-only to read-write via a "force".
97
98 &I Display information about the connection.
99
100 &J Switch from read-only to read-write via a "join".
101
102 &L Replay up the the last 4KB of console output. This escape
103 requires the console device to have logging enabled in the con‐
104 mand configuration.
105
106 &M Switch from read-write to read-only.
107
108 &Q Toggle quiet-mode to display/suppress informational messages.
109
110 &R Reset the node associated with this console. This escape
111 requires a "resetcmd" to be specified in the conmand configura‐
112 tion.
113
114 &Z Suspend the client.
115
116
118 The following environment variables override the default settings.
119
120 CONMAN_HOST
121 Specifies the hostname or IP address at which to contact con‐
122 mand, but may be overridden by the '-d' command-line option. A
123 port number separated by a colon may follow the hostname (i.e.,
124 host:port), although the CONMAN_PORT environment variable takes
125 precedence. If not set, the default host [127.0.0.1] will be
126 used.
127
128 CONMAN_PORT
129 Specifies the port on which to contact conmand, but may be over‐
130 ridden by the '-d' command-line option. If not set, the default
131 port [7890] will be used.
132
133 CONMAN_ESCAPE
134 The first character of this variable specifies the escape char‐
135 acter, but may be overridden by the '-e' command-line option.
136 If not set, the default escape character [&] will be used.
137
138
140 The client/server communications are not yet encrypted.
141
142
144 Chris Dunlap <cdunlap@llnl.gov>
145
146
148 Copyright (C) 2007-2018 Lawrence Livermore National Security, LLC.
149 Copyright (C) 2001-2007 The Regents of the University of California.
150
151
153 ConMan is free software: you can redistribute it and/or modify it under
154 the terms of the GNU General Public License as published by the Free
155 Software Foundation, either version 3 of the License, or (at your
156 option) any later version.
157
158
160 conman.conf(5), conmand(8).
161
162 https://dun.github.io/conman/
163
164
165
166conman-0.3.0 2018-09-15 CONMAN(1)