conman(1)

1
2CONMAN(1)                            LLNL                            CONMAN(1)
3
4
5

NAME

7       conman - ConMan client
8
9

SYNOPSIS

11       conman [OPTION]... [CONSOLE]...
12
13

DESCRIPTION

15       conman  is a program for connecting to remote consoles being managed by
16       conmand.  Console names can  be  separated  by  spaces  and/or  commas.
17       Globbing is used by default to match console names against the configu‐
18       ration, but regular expression matching can be enabled  with  the  '-r'
19       option.
20
21       conman  supports  three  modes  of console access: monitor (read-only),
22       interactive (read-write), and broadcast (write-only).  If  neither  the
23       '-m'  (monitor) nor '-b' (broadcast) options are specified, the console
24       session is opened in interactive mode.
25
26

OPTIONS

28       -b     Broadcast to multiple consoles (write-only).  Data sent  by  the
29              client will be copied to all specified consoles in parallel, but
30              console output will not be sent back to the client.  This option
31              can be used in conjunction with '-f' or '-j'.
32
33       -d destination
34              Specify  the  location  of  the  conmand  daemon, overriding the
35              default [127.0.0.1:7890].  This location may contain a  hostname
36              or  IP  address,  and be optionally followed by a colon and port
37              number.
38
39       -e character
40              Specify the client escape character, overriding the default [&].
41
42       -f     Specify that write-access to the  console  should  be  "forced",
43              thereby  stealing  the console away from existing clients having
44              write privileges.  The original clients are informed by  conmand
45              of  who  perpetrated  the  theft as their connections are termi‐
46              nated.
47
48       -F file
49              Read console names/patterns from file.  Only  one  console  name
50              may  be  specified  per  line.  Leading and trailing whitespace,
51              blank lines, and comments (ie, lines beginning with a  '#')  are
52              ignored.
53
54       -h     Display a summary of the command-line options.
55
56       -j     Specify  that  write-access  to  the console should be "joined",
57              thereby sharing the console with existing clients  having  write
58              privileges.  The original clients are informed by conmand that a
59              new client has been granted write privileges.
60
61       -l file
62              Log console session output to file.
63
64       -L     Display license information.
65
66       -m     Monitor a console (read-only).
67
68       -q     Query conmand for consoles  matching  the  specified  names/pat‐
69              terns.  Output from this query can be saved to file for use with
70              the '-F' option.
71
72       -Q     Enable quiet-mode,  suppressing  informational  messages.   This
73              mode  can  be  toggled  within  a  console  session via the '&Q'
74              escape.
75
76       -r     Match console names via regular expressions instead of globbing.
77
78       -v     Enable verbose mode.
79
80       -V     Display version information.
81
82

ESCAPE CHARACTERS

84       The following escapes are supported and assume the default escape char‐
85       acter [&]:
86
87       &?     Display a list of currently available escapes.
88
89       &.     Terminate the connection.
90
91       &&     Send a single escape character.
92
93       &B     Send a "serial-break" to the remote console.
94
95       &F     Switch from read-only to read-write via a "force".
96
97       &I     Display information about the connection.
98
99       &J     Switch from read-only to read-write via a "join".
100
101       &L     Replay  up  the  the  last  4KB  of console output.  This escape
102              requires the console device to have logging enabled in the  con‐
103              mand configuration.
104
105       &M     Switch from read-write to read-only.
106
107       &Q     Toggle quiet-mode to display/suppress informational messages.
108
109       &R     Reset  the  node  associated  with  this  console.   This escape
110              requires a "resetcmd" to be specified in the conmand  configura‐
111              tion.
112
113       &Z     Suspend the client.
114
115

ENVIRONMENT

117       The following environment variables override the default settings.
118
119       CONMAN_HOST
120              Specifies  the  hostname  or IP address at which to contact con‐
121              mand, but may be overridden by the '-d' command-line option.   A
122              port  number  separated  by a colon may follow the hostname (ie,
123              host:port), although the CONMAN_PORT environment variable  takes
124              precedence.   If  not  set, the default host [127.0.0.1] will be
125              used.
126
127       CONMAN_PORT
128              Specifies the port on which to contact conmand, but may be over‐
129              ridden by the '-d' command-line option.  If not set, the default
130              port [7890] will be used.
131
132       CONMAN_ESCAPE
133              The first character of this variable specifies the escape  char‐
134              acter,  but  may  be overridden by the '-e' command-line option.
135              If not set, the default escape character [&] will be used.
136
137

SECURITY

139       The client/server communications are not yet encrypted.
140
141

AUTHOR

143       Chris Dunlap <cdunlap@llnl.gov>
144
145

COPYRIGHT

147       Copyright (C) 2001-2006 by the Regents of the University of California.
148       Produced    at   Lawrence   Livermore   National   Laboratory.    UCRL-
149       CODE-2002-009.
150
151       ConMan is free software; you can redistribute it and/or modify it under
152       the  terms  of  the GNU General Public License as published by the Free
153       Software Foundation.
154
155