1CMST(1) General Commands Manual CMST(1)
2
6 CMST - Connman System Tray
7
9 Usage: cmst [options]
10
12 A QT5 based GUI front end for the Connman network daemon
13
15 -b, --bypass-restore-state
16 If restore state is specified in the settings file this take
17 precedence over that setting and not restore the state when
18 starting.
19 -B, --bypass-start-options
21 Ignore completely any start options specified in the settings
22 file.
23 -c, --enable-counters [Experimental]
25 Enable the counters. Counters are disabled by default to mini‐
26 mize load on your system.
27 -d, --disable-tray-icon
29 Disable the system tray icon. May be needed for system trays
30 not compliant with the Freedesktop.org system tray specifica‐
31 tion.
32 -h, --help
34 Displays this help.
35 -i, --icon-theme <Icon Theme Name>
37 Use a specific icon theme from your system. The Icon Theme name
38 is optional and if specified CMST will try to use icons from
39 that theme. If no name is provided and if a system wide icon
40 theme is defined (via your DE) it will be used. If the icon
41 theme cannot be found CMST will fallback to using internal built
42 in icons.
43 -l, --log-input-request
45 Log the Connman inputRequest for debugging purposes.
46 -m, --minimized
48 Start the GUI minimized in the system tray.
49 -M, --disable-minimize
51 Disable the minimize button. Use when you want the window man‐
52 ager to have sole control in minimizing the interface.
53 -n, --disable-vpn
55 Disable VPN support. This will disable (grey out) the VPN tab
56 and the VPN editor button. More importantly it will also bypass
57 setting up a DBUS connection to connman-vpn. If Connman is com‐
58 piled without VPN support this option should be supplied.
59 -v, --version
61 Displays version information.
62 -w, --wait-time <seconds>
64 Specify the wait time in seconds before starting the system tray
65 icon (default is 0 seconds). If CMST is started and tries to
66 create a tray icon before the system tray itself is created a
67 dialog will be displayed explaining that. This sometimes hap‐
68 pens when the program is started automatically. If you know the
69 tray will exist once the system is up you may specify a wait
70 time and CMST will wait that number of seconds before trying to
71 create the tray icon. This is to give the window manager or
72 panel time to create the tray before we try to place the icon
73 there.
74 --counter-update-kb <KB> [Experimental]
76 Specify the amount of data in KB that must be transmitted before
77 the counters update (default is 1024 KB). Connman will accept
78 this entry, but according to a comment in the Connman code the
79 actual feature still needs to be implemented.
80 --counter-update-rate <seconds> [Experimental]
82 Specify the frequency in seconds between counter updates
83 (default is 10 seconds).
84 --fake-transparency <RRGGBB>
86 On some systems the system tray icon background, which is trans‐
87 parent, will display as white or black. This seems to be an
88 issue between QT, system tray implementations, compositing, and
89 perhaps certain graphics cards. To work around it we've imple‐
90 mented a fake transparency for tray icons. To use it specify
91 the system tray background color with this option. If the back‐
92 ground color is provided CMST will convert the tray icon image
93 to have the specified background color. Color is a hex number
94 in the format: RRGGBB.
95 --use-xfce
97 Use code specific for XFCE. As of 2014.11.24 there seems to be
98 a problem with QT5.3 and the XFCE system tray. There is code in
99 the program to try and work around this issue. If the bug gets
100 fixed in QT5.4 (or later) this option will remain so that user
101 start up scripts and commands do not break, but it will be a no
102 operation place holder.
103 --use-mate
105 Use code specific for MATE. As of 2014.11.24 there seems to be
106 a problem with QT5.3 and the XFCE system tray. There is code in
107 the program to try and work around this issue. If the bug gets
108 fixed in QT5.4 (or later) this option will remain so that user
109 start up scripts and commands do not break, but it will be a no
110 operation place holder.
111
113 Command line options marked [Experimental] refer to some option in Con‐
114 nman that is currently flagged experimental. These options should not
115 be assumed to be fixed and could change at any time. Other command
116 line options may be assumed to be fixed and should be safe to use in
117 startup scripts.
118
120 The GUI contains one main dialog with separate tab pages. Program help
121 is mainly provided through a "What's This" interface. The "What's
122 This" button in the lower left corner will allow you to enter "What's
123 This" mode, click the button and then click the GUI feature, or control
124 that you are interested in. A right mouse click on a GUI feature or
125 control will also enter "What's This" mode.
126 Status Tab
128 The status tab displays information about the global properties,
129 found technologies, and services. Checkbox at the top right will
130 allow you to put everything in "offline" mode. To toggle a
131 technology on or off click the entry under the Powered column
132 Details Tab
134 The details tab will display detailed setup and connection
135 information about a service. Select the service you wish to
136 investigate in the combo box at the top.
137 Wireless Tab
139 The Wireless tab will display information, connect, disconnect,
140 and edit certain properties of wireless services.
141 VPN Tab
143 The VNP tab will display information, connect and disconnect
144 already provisioned VPN services.
145 Counters Tab
147 The Counters tab will display information about the Connect
148 time, the Transmit (TX) and Receiving (RX) counters for the ser‐
149 vice currently in the "online" state. The counters are set to
150 fairly course intervals to minimize system usage. Currently
151 these interval settings are hard coded into the program.
152 Preferences Tab
154 The preferences tab will allow you to change some aspects of the
155 GUI.
156
158 For typical networks and access points, even hidden ones, Connman will
159 find and automatically configure the network for you. If Connman needs
160 information, for instance a passphrase, CMST registers an agent and
161 this agent will prompt you for the needed information. For most cases
162 this "just works", however there are options for fine tuning the auto‐
163 matic configuration or creating provisioning files.
164 Profile Editor
166 There are a variety of connection settings that may be used to
167 override the automatic settings. An editor is provided to
168 access these settings via the Configuration button in the lower
169 right corner of the Details tab. One common use is to define a
170 static IP address for the connection. Hidden or provisioned
171 (see below) services cannot be edited.
172 802.1x Encrypted Networks (Eduroam and similar)
174 Certain types encrypted networks require a config (provisioning)
175 file to be created before you first connect. As of 2014.10.30
176 CMST has a provisioning editor built in, but it is considered an
177 advanced control and by default it is hidden. To enable the
178 control check the Advanced Controls box on the Provisioning tab.
179 The button to open the editor will appear in the lower left cor‐
180 ner of the dialog. With this editor you may create, open, edit,
181 delete and save config files to /var/lib/connman. The menu at
182 the top may be used to enter some information automatically, and
183 many of the input fields are validated as you enter text into
184 them. There are also predefined template files that may be used
185 to seed the editing area. All of this can be bypassed if you
186 wish and you may cut and paste or type into the editor directly.
187 Creating and Editing VPN Connections
189 As of 2016.01.26 CMST has a VPN provisioning editor built in,
190 but it is considered an advanced control and by default it is
191 hidden. To enable the control check the Advanced Controls box
192 on the Provisioning tab. The button to open the editor will
193 appear in the lower left corner of the dialog. With this editor
194 you may create, open, edit, delete and save config files to
195 /var/lib/connman-vpn. The menu at the top may be used to enter
196 some information automatically, and many of the input fields are
197 validated as you enter text into them. The first item under each
198 menu heading (Provider xxx) will start a junior wizard to walk
199 you through entering all the mandatory information for each con‐
200 nection type. For OpenVPN the second menu item (Import Configu‐
201 ration) will import an OpenVPN .opvn file. The import will
202 extract and save keys and certificates and will place the proper
203 provisioning entries into the editor window.
204
206 For the tray icon to display is it required that the system tray be
207 compliant with the Freedesktop.org systemtray specification.
208 The tray icon is known to not work in the DWM system tray which appears
210 to be a noncompliant tray.
211
214 Andrew J. Bibb. Project web page: https://github.com/andrew-bibb/cmst
215Version: 2018.01.06 06 January 2018 CMST(1)