doc/connmanctl.1

   1 .TH connmanctl 1 07/31/2012 "" "User Commands for Connman CLI"
   2 .SH
   3 NAME
   4 connmanctl \- Connman CLI
   5 .SH
   6 SYNOPSIS
   7 .BR connmanctl " ["
   8 .BR enable " <technology> | "
   9 .BR offlinemode "] ["
  10 .BR disable " <technology> | "
  11 .BR offlinemode "] ["
  12 .BR technologies "] ["
  13 .BR state "] ["
  14 .BR services " [\-\-properties <service>]] ["
  15 .BR scan " <technology>] ["
  16 .BR connect " <service>] ["
  17 .BR config " <service> \-\-<option> ARGS...] ["
  18 .BR help " | \-\-help]"
  19 .PP
  20 .SH
  21 DESCRIPTION
  22 Connmanctl is a Connman command line interface which can be run in two modes:
  23 a plain synchronous command input, and an asynchronous interactive shell.
  24 To run a specific command the user may enter connmanctl <command> [options]
  25 [args], or enter connmanctl; in this case, the program will drop into the
  26 interactive shell.
  27 .PP
  28 Connmantl can handle most simple network connections. It is able to enable/
  29 disable any technology that exists on the system, display a list of
  30 services available, connect to/disconnect from any unsecured networks,
  31 show properties of the system, the technologies, and any individual
  32 service, and configure all of the properties. It is also able to monitor
  33 changes in the properties of the services, technologies, and the system.
  34 .PP
  35 In the interactive shell, all of the same commands can be used. It
  36 provides quicker usage when needing to use connmanctl more extensively.
  37 .SH
  38 COMMANDS AND OPTIONS
  39 .TP
  40 .BR "help | \-\-help | " "(no arguments)"
  41 Shows the abbreviated help menu in the terminal.
  42 .PP
  43 .TP
  44 .BR enable " <technology>"
  45 Enables the given technology type (e.g. ethernet, wifi, 3g, etc.)
  46 Turns power on to the technology, but doesn't connect unless
  47 there is a service with autoconnect set to True.
  48 .PP
  49 .TP
  50 .BR disable " <technology>"
  51 Disables the given technology type. Turns power off to the
  52 technology and disconnects if it is already connected.
  53 .PP
  54 .TP
  55 .B enable offlinemode
  56 Enables offline mode. Disconnects and powers down all
  57 technologies system-wide, however each technology can be powered
  58 back on individually.
  59 .PP
  60 .TP
  61 .B disable offlinemode
  62 Disables offline mode. Technologies are powered back on according
  63 to their individual policies.
  64 .PP
  65 .TP
  66 .B technologies
  67 Shows a list of all technology types existing on the system and
  68 their properties. See the properties section of the Technology
  69 API for explanations of each property.
  70 .PP
  71 .TP
  72 .B state
  73 Shows the system properties. Includes ths online state of the
  74 system, offline mode, and session mode.
  75 .PP
  76 .TP
  77 .BR scan " <technology>"
  78 Scans for new services on the given technology.
  79 .PP
  80 .TP
  81 .B services
  82 Shows a list of all available service names. This includes the
  83 names of wifi networks, the wired ethernet connection, names of
  84 bluetooth devices, etc. These are the names used when a
  85 <service> command is called for. The service name
  86 (e.g. Joes-wifi), the service path (e.g.
  87 wifi_6834534139723_managed_none), or the full service path (e.g.
  88 /net/connman/Service/wifi_5467631...) are all accepted as valid
  89 input. An asterisk in front of the service indicates that the
  90 service is favorited, and a "C" indicates a service that is
  91 already connected.
  92 .PP
  93 .TP
  94 .BR "services \-\-properties" " <service>"
  95 Shows a list of all properties for that service. See the
  96 properties section of the Service API for explanations of each
  97 property.
  98 .PP
  99 .TP
 100 .BR connect " <service>"
 101 Connects to the given service if it is unsecured.
 102 .PP
 103 .TP
 104 .BR disconnect " <service>"
 105 Disconnects from the given service.
 106 .PP
 107 .TP
 108 .BR config " <service> " \-\-<option>
 109 Configures a writable property of the given service to the
 110 value(s) entered after --<option>.
 111 .PP
 112 .TP
 113 .BR monitor " [\-\-<option>]"
 114 Listens for and displays DBus signals sent by Connman. The option indicates
 115 which signals you want to subscribe to. If no option is entered, it displays
 116 all signals from all interfaces.
 117 .PP
 118 .SS
 119 Config Options:
 120 .PP
 121 .TP
 122 .B \-\-autoconnect=y/n
 123 Sets the autoconnect property of the service.
 124 .PP
 125 .TP
 126 .B \-\-ipv4
 127 Configures the IPv4 settings for the service. Enter the settings
 128 in the order "Method", "Address", "Netmask", then "Gateway"
 129 after the argument. See the properties section of the Service
 130 API for more information on these settings and the values
 131 accepted for them. It also displays a list of changes to both the
 132 IPv4 settings, and incidental changes to other values related to
 133 it.
 134 .PP
 135 .TP
 136 .B \-\-ipv6
 137 Configures the IPv6 settings for the service. Enter the settings
 138 in the order "Method", "Address", "PrefixLength", "Gateway", then
 139 "Privacy". See the properties section of the Service API for more
 140 information on these settings and the values accepted for them.
 141 It also displays a list of entered changes to the IPv6 settings,
 142 and incidental changes to other values related to it.
 143 .PP
 144 .TP
 145 .B \-\-nameservers
 146 Adds to the list of manually configured domain name servers.
 147 Enter the name servers after the argument separated by spaces.
 148 .PP
 149 .TP
 150 .B \-\-timeservers
 151 Adds to the list of manually configured time servers. Enter the
 152 time servers after the argument separated by spaces.
 153 .PP
 154 .TP
 155 .B \-\-domains
 156 Adds to the list of manually configured search domains. Enter
 157 the domains after the argument, separated by spaces.
 158 .PP
 159 .TP
 160 .B \-\-proxy
 161 Configures the IPv6 settings for the service. Enter the settings in the
 162 order "Method", "URL". If the Method is set to "direct", no other arguments
 163 are taken. If the Method is set to "auto", the URL is optional. To set the
 164 Servers and Excludes manually, enter "manual" followed by "servers" with a
 165 list of servers separated by spaces. Then, optionally, the word "excludes"
 166 followed by a list of excludes separated by spaces. e.g. "./connmanctl config
 167 joes-wifi \-\-proxy manual servers serv1 serv2 serv3 excludes excl1 excl2"
 168 .PP
 169 .SS
 170 Monitor Options:
 171 .PP
 172 .TP
 173 .B \-\-services
 174 Listens for and displays the PropertyChanged signal from the Service interface.
 175 Also displays the service name (e.g. Joes-wifi) that the property is part of.
 176 More information, including a list of possible properties can be found in the
 177 Service API.
 178 .PP
 179 .TP
 180 .B \-\-tech
 181 Listens for and displays the PropertyChanged signal from the Technology
 182 interface. More information, including a list of possible properties can be
 183 found in the Technology API.
 184 .PP
 185 .TP
 186 .B \-\-manager
 187 Listens for and displays the PropertyChanged, ServicesChanged, TechnologyAdded,
 188 and TechnologyRemoved signals from the Manager interface. More information on
 189 these signals and a list of possible properties can be found in the Manager API.
 190 .PP