projects / thirdparty / systemd.git / blame
| Commit | Line | Data |
|---|---|---|
| 7874bcd6 LP |
1 | <?xml version='1.0'?> <!--*-nxml-*--> |
| 2 | <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" | |
| 3 | "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> | |
| 4 | ||
| 5 | <!-- | |
| 6 | This file is part of systemd. | |
| 7 | ||
| 8 | Copyright 2010 Lennart Poettering | |
| 9 | ||
| 10 | systemd is free software; you can redistribute it and/or modify it | |
| 5430f7f2 LP |
11 | under the terms of the GNU Lesser General Public License as published by |
| 12 | the Free Software Foundation; either version 2.1 of the License, or | |
| 7874bcd6 LP |
13 | (at your option) any later version. |
| 14 | ||
| 15 | systemd is distributed in the hope that it will be useful, but | |
| 16 | WITHOUT ANY WARRANTY; without even the implied warranty of | |
| 17 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU | |
| 5430f7f2 | 18 | Lesser General Public License for more details. |
| 7874bcd6 | 19 | |
| 5430f7f2 | 20 | You should have received a copy of the GNU Lesser General Public License |
| 7874bcd6 LP |
21 | along with systemd; If not, see <http://www.gnu.org/licenses/>. |
| 22 | --> | |
| 23 | ||
| ee5762e3 | 24 | <refentry id="systemctl"> |
| 7874bcd6 LP |
25 | |
| 26 | <refentryinfo> | |
| 27 | <title>systemctl</title> | |
| 28 | <productname>systemd</productname> | |
| 29 | ||
| 30 | <authorgroup> | |
| 31 | <author> | |
| 32 | <contrib>Developer</contrib> | |
| 33 | <firstname>Lennart</firstname> | |
| 34 | <surname>Poettering</surname> | |
| 35 | <email>lennart@poettering.net</email> | |
| 36 | </author> | |
| 37 | </authorgroup> | |
| 38 | </refentryinfo> | |
| 39 | ||
| 40 | <refmeta> | |
| 41 | <refentrytitle>systemctl</refentrytitle> | |
| 42 | <manvolnum>1</manvolnum> | |
| 43 | </refmeta> | |
| 44 | ||
| 45 | <refnamediv> | |
| 46 | <refname>systemctl</refname> | |
| af2d49f7 | 47 | <refpurpose>Control the systemd system and service manager</refpurpose> |
| 7874bcd6 LP |
48 | </refnamediv> |
| 49 | ||
| 50 | <refsynopsisdiv> | |
| 51 | <cmdsynopsis> | |
| 52 | <command>systemctl <arg choice="opt" rep="repeat">OPTIONS</arg> <arg choice="req">COMMAND</arg> <arg choice="opt" rep="repeat">NAME</arg></command> | |
| 53 | </cmdsynopsis> | |
| 54 | </refsynopsisdiv> | |
| 55 | ||
| 56 | <refsect1> | |
| 57 | <title>Description</title> | |
| 58 | ||
| 59 | <para><command>systemctl</command> may be used to | |
| 60 | introspect and control the state of the | |
| 61 | <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry> | |
| af2d49f7 | 62 | system and service manager.</para> |
| 7874bcd6 LP |
63 | </refsect1> |
| 64 | ||
| 65 | <refsect1> | |
| 66 | <title>Options</title> | |
| 67 | ||
| 68 | <para>The following options are understood:</para> | |
| 69 | ||
| 70 | <variablelist> | |
| 71 | <varlistentry> | |
| 72 | <term><option>--help</option></term> | |
| 7594fb25 | 73 | <term><option>-h</option></term> |
| 7874bcd6 LP |
74 | |
| 75 | <listitem><para>Prints a short help | |
| 76 | text and exits.</para></listitem> | |
| 77 | </varlistentry> | |
| 78 | ||
| 59cddb23 LP |
79 | <varlistentry> |
| 80 | <term><option>--version</option></term> | |
| 81 | ||
| 82 | <listitem><para>Prints a short version | |
| 83 | string and exits.</para></listitem> | |
| 84 | </varlistentry> | |
| 85 | ||
| 7874bcd6 LP |
86 | <varlistentry> |
| 87 | <term><option>--type=</option></term> | |
| 7594fb25 | 88 | <term><option>-t</option></term> |
| 7874bcd6 LP |
89 | |
| 90 | <listitem><para>When listing units, | |
| 91 | limit display to certain unit | |
| 92 | types. If not specified units of all | |
| 93 | types will be shown. The argument | |
| 94 | should be a unit type name such as | |
| 95 | <option>service</option>, | |
| 96 | <option>socket</option> and | |
| 97 | similar.</para></listitem> | |
| 98 | </varlistentry> | |
| 99 | ||
| 393a2f9b LP |
100 | <varlistentry> |
| 101 | <term><option>--property=</option></term> | |
| 102 | <term><option>-p</option></term> | |
| 103 | ||
| 104 | <listitem><para>When showing | |
| a61933ad | 105 | unit/job/manager properties, limit |
| ee5762e3 LP |
106 | display to certain properties as |
| 107 | specified as argument. If not | |
| 108 | specified all set properties are | |
| 393a2f9b LP |
109 | shown. The argument should be a |
| 110 | property name, such as | |
| ea4a240d LP |
111 | <literal>MainPID</literal>. If |
| 112 | specified more than once all | |
| 113 | properties with the specified names | |
| 114 | are shown.</para></listitem> | |
| 393a2f9b LP |
115 | </varlistentry> |
| 116 | ||
| 7874bcd6 LP |
117 | <varlistentry> |
| 118 | <term><option>--all</option></term> | |
| 7594fb25 | 119 | <term><option>-a</option></term> |
| 7874bcd6 LP |
120 | |
| 121 | <listitem><para>When listing units, | |
| 122 | show all units, regardless of their | |
| 393a2f9b | 123 | state, including inactive units. When |
| a61933ad | 124 | showing unit/job/manager properties, |
| 393a2f9b LP |
125 | show all properties regardless whether |
| 126 | they are set or not.</para></listitem> | |
| 7874bcd6 LP |
127 | </varlistentry> |
| 128 | ||
| 30732560 LP |
129 | <varlistentry> |
| 130 | <term><option>--failed</option></term> | |
| 131 | ||
| 132 | <listitem><para>When listing units, | |
| 133 | show only failed units. Do not confuse | |
| 134 | with | |
| 135 | <option>--fail</option>.</para></listitem> | |
| 136 | </varlistentry> | |
| 137 | ||
| 8fe914ec LP |
138 | <varlistentry> |
| 139 | <term><option>--full</option></term> | |
| 140 | ||
| 141 | <listitem><para>Do not ellipsize unit | |
| f73e33d9 LP |
142 | names and truncate unit descriptions |
| 143 | in the output of | |
| 8fe914ec LP |
144 | <command>list-units</command> and |
| 145 | <command>list-jobs</command>.</para></listitem> | |
| 146 | </varlistentry> | |
| 147 | ||
| 7874bcd6 | 148 | <varlistentry> |
| 90d473a1 | 149 | <term><option>--fail</option></term> |
| 7874bcd6 LP |
150 | |
| 151 | <listitem><para>If the requested | |
| ee5762e3 LP |
152 | operation conflicts with a pending |
| 153 | unfinished job, fail the command. If | |
| 154 | this is not specified the requested | |
| 155 | operation will replace the pending job, | |
| 30732560 LP |
156 | if necessary. Do not confuse |
| 157 | with | |
| 158 | <option>--failed</option>.</para></listitem> | |
| ee5762e3 LP |
159 | </varlistentry> |
| 160 | ||
| e67c3609 LP |
161 | <varlistentry> |
| 162 | <term><option>--ignore-dependencies</option></term> | |
| 163 | ||
| 164 | <listitem><para>When enqueuing a new | |
| 165 | job ignore all its dependencies and | |
| 166 | execute it immediately. If passed no | |
| 167 | required units of the unit passed will | |
| 168 | be pulled in, and no ordering | |
| 169 | dependencies will be honoured. This is | |
| 170 | mostly a debugging and rescue tool for | |
| 171 | the administrator and should not be | |
| 172 | used by | |
| 173 | applications.</para></listitem> | |
| 174 | </varlistentry> | |
| 175 | ||
| ee5762e3 LP |
176 | <varlistentry> |
| 177 | <term><option>--quiet</option></term> | |
| 178 | <term><option>-q</option></term> | |
| 179 | ||
| 180 | <listitem><para>Suppress output to | |
| 181 | STDOUT in | |
| 182 | <command>snapshot</command>, | |
| 3d428115 | 183 | <command>is-active</command>, |
| ee5762e3 LP |
184 | <command>enable</command> and |
| 185 | <command>disable</command>.</para></listitem> | |
| 186 | </varlistentry> | |
| 187 | ||
| 188 | <varlistentry> | |
| 189 | <term><option>--no-block</option></term> | |
| 190 | ||
| a9c72fe9 LP |
191 | <listitem><para>Do not synchronously wait for |
| 192 | the requested operation to finish. If this is | |
| 193 | not specified the job will be verified, | |
| 194 | enqueued and <command>systemctl</command> will | |
| 195 | wait until it is completed. By passing this | |
| 196 | argument it is only verified and | |
| a61933ad LP |
197 | enqueued.</para></listitem> |
| 198 | </varlistentry> | |
| ee5762e3 | 199 | |
| 0736af98 | 200 | <varlistentry> |
| ebed32bf MS |
201 | <term><option>--no-legend</option></term> |
| 202 | ||
| 0e25e94e | 203 | <listitem><para>Do not print a legend, i.e. |
| ebed32bf | 204 | the column headers and the footer with hints. |
| 0e25e94e KS |
205 | </para></listitem> |
| 206 | </varlistentry> | |
| ebed32bf MS |
207 | |
| 208 | <varlistentry> | |
| 0736af98 MV |
209 | <term><option>--no-pager</option></term> |
| 210 | ||
| 0e25e94e KS |
211 | <listitem><para>Do not pipe output into a |
| 212 | pager.</para></listitem> | |
| 213 | </varlistentry> | |
| 0736af98 | 214 | |
| ee5762e3 LP |
215 | <varlistentry> |
| 216 | <term><option>--system</option></term> | |
| 217 | ||
| 218 | <listitem><para>Talk to the systemd | |
| 219 | system manager. (Default)</para></listitem> | |
| 220 | </varlistentry> | |
| 221 | ||
| 222 | <varlistentry> | |
| af2d49f7 | 223 | <term><option>--user</option></term> |
| ee5762e3 LP |
224 | |
| 225 | <listitem><para>Talk to the systemd | |
| af2d49f7 | 226 | manager of the calling user.</para></listitem> |
| 7874bcd6 LP |
227 | </varlistentry> |
| 228 | ||
| 4445a875 LP |
229 | <varlistentry> |
| 230 | <term><option>--order</option></term> | |
| 231 | <term><option>--require</option></term> | |
| 232 | ||
| 233 | <listitem><para>When used in | |
| 234 | conjunction with the | |
| 235 | <command>dot</command> command (see | |
| 236 | below), selects which dependencies are | |
| 237 | shown in the dependency graph. If | |
| 238 | <option>--order</option> is passed | |
| 239 | only dependencies of type | |
| 240 | <varname>After=</varname> or | |
| 241 | <varname>Before=</varname> are | |
| 242 | shown. If <option>--require</option> | |
| 243 | is passed only dependencies of type | |
| 244 | <varname>Requires=</varname>, | |
| 245 | <varname>RequiresOverridable=</varname>, | |
| 246 | <varname>Requisite=</varname>, | |
| 247 | <varname>RequisiteOverridable=</varname>, | |
| 248 | <varname>Wants=</varname> and | |
| 249 | <varname>Conflicts=</varname> are | |
| 250 | shown. If neither is passed, shows | |
| 251 | dependencies of all these | |
| 252 | types.</para></listitem> | |
| 253 | </varlistentry> | |
| 254 | ||
| 7874bcd6 | 255 | <varlistentry> |
| ee5762e3 | 256 | <term><option>--no-wall</option></term> |
| 7874bcd6 | 257 | |
| ee5762e3 LP |
258 | <listitem><para>Don't send wall |
| 259 | message before | |
| 260 | halt, power-off, reboot.</para></listitem> | |
| 7874bcd6 LP |
261 | </varlistentry> |
| 262 | ||
| 263 | <varlistentry> | |
| ee5762e3 LP |
264 | <term><option>--global</option></term> |
| 265 | ||
| 266 | <listitem><para>When used with | |
| 267 | <command>enable</command> and | |
| 268 | <command>disable</command>, operate on the | |
| 3d428115 | 269 | global user configuration |
| ee5762e3 LP |
270 | directory, thus enabling or disabling |
| 271 | a unit file globally for all future | |
| af2d49f7 | 272 | logins of all users.</para></listitem> |
| 7874bcd6 LP |
273 | </varlistentry> |
| 274 | ||
| 275 | <varlistentry> | |
| ee5762e3 LP |
276 | <term><option>--no-reload</option></term> |
| 277 | ||
| 278 | <listitem><para>When used with | |
| 279 | <command>enable</command> and | |
| 280 | <command>disable</command>, do not | |
| 281 | implicitly reload daemon configuration | |
| 282 | after executing the | |
| 283 | changes.</para></listitem> | |
| 284 | </varlistentry> | |
| 7594fb25 | 285 | |
| 501fc174 LP |
286 | <varlistentry> |
| 287 | <term><option>--no-ask-password</option></term> | |
| 288 | ||
| 289 | <listitem><para>When used with | |
| 290 | <command>start</command> and related | |
| 291 | commands, disables asking for | |
| 292 | passwords. Background services may | |
| 293 | require input of a password or | |
| 294 | passphrase string, for example to | |
| 295 | unlock system hard disks or | |
| 296 | cryptographic certificates. Unless | |
| 297 | this option is specified and the | |
| 298 | command is invoked from a terminal | |
| 299 | <command>systemctl</command> will | |
| 300 | query the user on the terminal for the | |
| 301 | necessary secrets. Use this option to | |
| 6bb92a16 LP |
302 | switch this behavior off. In this case |
| 303 | the password must be supplied by some | |
| 304 | other means (for example graphical | |
| 305 | password agents) or the service might | |
| 306 | fail. This also disables querying the | |
| 307 | user for authentication for privileged | |
| 308 | operations.</para></listitem> | |
| 501fc174 LP |
309 | </varlistentry> |
| 310 | ||
| 8a0867d6 LP |
311 | <varlistentry> |
| 312 | <term><option>--kill-who=</option></term> | |
| 313 | ||
| 314 | <listitem><para>When used with | |
| 315 | <command>kill</command>, choose which | |
| 316 | processes to kill. Must be one of | |
| 317 | <option>main</option>, | |
| 318 | <option>control</option> or | |
| 319 | <option>all</option> to select whether | |
| 320 | to kill only the main process of the | |
| 321 | unit, the control process or all | |
| 3d428115 | 322 | processes of the unit. If omitted |
| 8a0867d6 LP |
323 | defaults to |
| 324 | <option>all</option>.</para></listitem> | |
| 325 | </varlistentry> | |
| 326 | ||
| 327 | <varlistentry> | |
| 3d428115 | 328 | <term><option>--signal=</option></term> |
| 8a0867d6 LP |
329 | <term><option>-s</option></term> |
| 330 | ||
| 331 | <listitem><para>When used with | |
| 332 | <command>kill</command>, choose which | |
| 333 | signal to send to selected | |
| 334 | processes. Must be one of the well | |
| 3d428115 | 335 | known signal specifiers such as |
| 8a0867d6 | 336 | SIGTERM, SIGINT or SIGSTOP. If |
| 3d428115 | 337 | omitted defaults to |
| 8a0867d6 LP |
338 | <option>SIGTERM</option>.</para></listitem> |
| 339 | </varlistentry> | |
| 340 | ||
| 7594fb25 | 341 | <varlistentry> |
| ee5762e3 | 342 | <term><option>--force</option></term> |
| 6f352544 | 343 | <term><option>-f</option></term> |
| 7874bcd6 | 344 | |
| ee5762e3 | 345 | <listitem><para>When used with |
| 7cf55dd0 | 346 | <command>enable</command>, overwrite any |
| ee5762e3 LP |
347 | existing conflicting |
| 348 | symlinks.</para></listitem> | |
| 6f352544 LP |
349 | |
| 350 | <listitem><para>When used with | |
| 351 | <command>halt</command>, | |
| 352 | <command>poweroff</command>, | |
| 353 | <command>reboot</command> or | |
| e606bb61 | 354 | <command>kexec</command> execute the |
| 6f352544 LP |
355 | selected operation without shutting |
| 356 | down all units. However, all processes | |
| 357 | will be killed forcibly and all file | |
| 358 | systems are unmounted or remounted | |
| 359 | read-only. This is hence a drastic but | |
| 360 | relatively safe option to request an | |
| e606bb61 LP |
361 | immediate reboot. If |
| 362 | <option>--force</option> is specified | |
| 363 | twice for these operations, they will | |
| 364 | be executed immediately without | |
| 365 | terminating any processes or umounting | |
| 366 | any file systems. Warning: specifying | |
| 367 | <option>--force</option> twice with | |
| 368 | any of these operations might result | |
| 369 | in data loss.</para></listitem> | |
| 7874bcd6 LP |
370 | </varlistentry> |
| 371 | ||
| 372 | <varlistentry> | |
| 729e3769 | 373 | <term><option>--root=</option></term> |
| ee5762e3 LP |
374 | |
| 375 | <listitem><para>When used with | |
| 729e3769 LP |
376 | <command>enable</command>/<command>disable</command>/<command>is-enabled</command> (and |
| 377 | related commands), use alternative | |
| 378 | root path when looking for unit | |
| 379 | files.</para></listitem> | |
| 7874bcd6 | 380 | </varlistentry> |
| a8f11321 | 381 | |
| be394c48 | 382 | <varlistentry> |
| 729e3769 | 383 | <term><option>--runtime</option></term> |
| be394c48 FC |
384 | |
| 385 | <listitem><para>When used with | |
| 729e3769 LP |
386 | <command>enable</command>/<command>disable</command>/<command>is-enabled</command> (and related commands), make |
| 387 | changes only temporarily, so that they | |
| 388 | are dropped on the next reboot. This | |
| 389 | will have the effect that changes are | |
| 390 | not made in subdirectories of | |
| 391 | <filename>/etc</filename> but in | |
| 392 | <filename>/run</filename>, with | |
| 393 | identical immediate effects, however, | |
| 394 | since the latter is lost on reboot, | |
| 395 | the changes are lost | |
| 396 | too.</para></listitem> | |
| be394c48 FC |
397 | </varlistentry> |
| 398 | ||
| a8f11321 LP |
399 | <varlistentry> |
| 400 | <term><option>-H</option></term> | |
| 401 | <term><option>--host</option></term> | |
| 402 | ||
| 403 | <listitem><para>Execute operation | |
| 9f7dad77 VS |
404 | remotely. Specify a hostname, or |
| 405 | username and hostname separated by @, | |
| a8f11321 LP |
406 | to connect to. This will use SSH to |
| 407 | talk to the remote systemd | |
| 408 | instance.</para></listitem> | |
| 409 | </varlistentry> | |
| 410 | ||
| 411 | <varlistentry> | |
| 412 | <term><option>-P</option></term> | |
| 413 | <term><option>--privileged</option></term> | |
| 414 | ||
| 415 | <listitem><para>Acquire privileges via | |
| 416 | PolicyKit before executing the | |
| 417 | operation.</para></listitem> | |
| 418 | </varlistentry> | |
| 5c3246b1 LP |
419 | |
| 420 | <varlistentry> | |
| 421 | <term><option>--lines=</option></term> | |
| 422 | <term><option>-n</option></term> | |
| 423 | ||
| 424 | <listitem><para>When used with | |
| 425 | <command>status</command> controls the | |
| 426 | number of journal lines to show, | |
| 427 | counting from the most recent | |
| 428 | ones. Takes a positive integer | |
| 429 | argument. Defaults to | |
| 430 | 10.</para></listitem> | |
| 431 | </varlistentry> | |
| 432 | ||
| 433 | <varlistentry> | |
| 434 | <term><option>--follow</option></term> | |
| 568b679f | 435 | <term><option>-f</option></term> |
| 5c3246b1 LP |
436 | |
| 437 | <listitem><para>When used with | |
| 438 | <command>status</command> continously | |
| 439 | prints new journal entries as they are | |
| 440 | appended to the | |
| 441 | journal.</para></listitem> | |
| 442 | </varlistentry> | |
| 443 | ||
| 444 | <varlistentry> | |
| 445 | <term><option>--output=</option></term> | |
| 446 | <term><option>-o</option></term> | |
| 447 | ||
| 448 | <listitem><para>When used with | |
| 449 | <command>status</command> controls the | |
| 450 | formatting of the journal entries that | |
| 451 | are shown. For the available choices | |
| 452 | see | |
| 169c4f65 | 453 | <citerefentry><refentrytitle>journalctl</refentrytitle><manvolnum>1</manvolnum></citerefentry>. Defaults |
| 5c3246b1 LP |
454 | to |
| 455 | <literal>short</literal>.</para></listitem> | |
| 456 | </varlistentry> | |
| 457 | ||
| 7874bcd6 LP |
458 | </variablelist> |
| 459 | ||
| 460 | <para>The following commands are understood:</para> | |
| 461 | ||
| 462 | <variablelist> | |
| 463 | <varlistentry> | |
| 464 | <term><command>list-units</command></term> | |
| 465 | ||
| 466 | <listitem><para>List known units.</para></listitem> | |
| 467 | </varlistentry> | |
| 7874bcd6 LP |
468 | <varlistentry> |
| 469 | <term><command>start [NAME...]</command></term> | |
| 470 | ||
| ee5762e3 LP |
471 | <listitem><para>Start (activate) one |
| 472 | or more units specified on the command | |
| 7874bcd6 LP |
473 | line.</para></listitem> |
| 474 | </varlistentry> | |
| 475 | <varlistentry> | |
| 476 | <term><command>stop [NAME...]</command></term> | |
| 477 | ||
| ee5762e3 LP |
478 | <listitem><para>Stop (deactivate) one |
| 479 | or more units specified on the command | |
| 7874bcd6 LP |
480 | line.</para></listitem> |
| 481 | </varlistentry> | |
| 7874bcd6 LP |
482 | <varlistentry> |
| 483 | <term><command>reload [NAME...]</command></term> | |
| 484 | ||
| ee5762e3 LP |
485 | <listitem><para>Asks all units listed |
| 486 | on the command line to reload their | |
| 7874bcd6 | 487 | configuration. Note that this will |
| ee5762e3 LP |
488 | reload the service-specific |
| 489 | configuration, not the unit | |
| 490 | configuration file of systemd. If you | |
| 491 | want systemd to reload the | |
| 492 | configuration file of a unit use the | |
| 7874bcd6 LP |
493 | <command>daemon-reload</command> |
| 494 | command. In other words: for the | |
| 495 | example case of Apache, this will | |
| 496 | reload Apache's | |
| 497 | <filename>httpd.conf</filename> in the | |
| 498 | web server, not the | |
| 499 | <filename>apache.service</filename> | |
| ee5762e3 LP |
500 | systemd unit file. </para> |
| 501 | ||
| 502 | <para>This command should not be | |
| 503 | confused with the | |
| 504 | <command>daemon-reload</command> or | |
| 505 | <command>load</command> | |
| 7874bcd6 LP |
506 | commands.</para></listitem> |
| 507 | ||
| 508 | </varlistentry> | |
| 509 | <varlistentry> | |
| 6f28c033 LP |
510 | <term><command>restart [NAME...]</command></term> |
| 511 | ||
| 512 | <listitem><para>Restart one or more | |
| 513 | units specified on the command | |
| 514 | line. If the units are not running yet | |
| 515 | they will be | |
| 516 | started.</para></listitem> | |
| 517 | </varlistentry> | |
| 518 | <varlistentry> | |
| 519 | <term><command>try-restart [NAME...]</command></term> | |
| 520 | ||
| 521 | <listitem><para>Restart one or more | |
| 522 | units specified on the command | |
| f1f8cfd0 AB |
523 | line if the units are running. Do |
| 524 | nothing if units are not running. | |
| 525 | Note that for compatibility | |
| 9bee76ee RB |
526 | with Red Hat init scripts |
| 527 | <command>condrestart</command> is | |
| 528 | equivalent to this command.</para></listitem> | |
| 6f28c033 LP |
529 | </varlistentry> |
| 530 | <varlistentry> | |
| 531 | <term><command>reload-or-restart [NAME...]</command></term> | |
| 9bee76ee RB |
532 | |
| 533 | <listitem><para>Reload one or more | |
| 534 | units if they support it. If not, | |
| 535 | restart them instead. If the units | |
| 536 | are not running yet they will be | |
| 537 | started.</para></listitem> | |
| 538 | </varlistentry> | |
| 539 | <varlistentry> | |
| 6f28c033 LP |
540 | <term><command>reload-or-try-restart [NAME...]</command></term> |
| 541 | ||
| 542 | <listitem><para>Reload one or more | |
| ee5762e3 | 543 | units if they support it. If not, |
| 100fd567 LP |
544 | restart them instead. Do nothing if |
| 545 | the units are not running. Note that | |
| 546 | for compatibility with SysV init | |
| 547 | scripts | |
| 9bee76ee | 548 | <command>force-reload</command> is |
| 100fd567 LP |
549 | equivalent to this |
| 550 | command.</para></listitem> | |
| 6f28c033 LP |
551 | </varlistentry> |
| 552 | <varlistentry> | |
| 7874bcd6 LP |
553 | <term><command>isolate [NAME]</command></term> |
| 554 | ||
| 555 | <listitem><para>Start the unit | |
| 556 | specified on the command line and its | |
| 25f63d46 MM |
557 | dependencies and stop all others.</para> |
| 558 | ||
| 559 | <para>This is similar to changing the | |
| 560 | runlevel in a traditional init system. The | |
| 561 | <command>isolate</command> command will | |
| 562 | immediately stop processes that are not | |
| 563 | enabled in the new unit, possibly including | |
| 564 | the graphical environment or terminal you | |
| 565 | are currently using.</para> | |
| 566 | ||
| 567 | <para>Note that this works only on units | |
| 568 | where <option>AllowIsolate=</option> is | |
| 2528a7a6 LP |
569 | enabled. See |
| 570 | <citerefentry><refentrytitle>systemd.unit</refentrytitle><manvolnum>5</manvolnum></citerefentry> | |
| 571 | for details.</para></listitem> | |
| 7874bcd6 | 572 | </varlistentry> |
| 8a0867d6 LP |
573 | <varlistentry> |
| 574 | <term><command>kill [NAME...]</command></term> | |
| 575 | ||
| 576 | <listitem><para>Send a signal to one | |
| 577 | or more processes of the unit. Use | |
| 578 | <option>--kill-who=</option> to select | |
| 579 | which process to kill. Use | |
| 580 | <option>--kill-mode=</option> to | |
| 581 | select the kill mode and | |
| 582 | <option>--signal=</option> to select | |
| 583 | the signal to send.</para></listitem> | |
| 584 | </varlistentry> | |
| 7594fb25 | 585 | <varlistentry> |
| ee5762e3 | 586 | <term><command>is-active [NAME...]</command></term> |
| 7594fb25 LP |
587 | |
| 588 | <listitem><para>Check whether any of | |
| 3d428115 | 589 | the specified units are active |
| ee5762e3 LP |
590 | (i.e. running). Returns an exit code |
| 591 | 0 if at least one is active, non-zero | |
| 7594fb25 LP |
592 | otherwise. Unless |
| 593 | <option>--quiet</option> is specified | |
| 594 | this will also print the current unit | |
| 595 | state to STDOUT.</para></listitem> | |
| 596 | </varlistentry> | |
| 61cbdc4b | 597 | <varlistentry> |
| 75676b72 | 598 | <term><command>status [NAME...|PID...]</command></term> |
| 61cbdc4b | 599 | |
| ee5762e3 LP |
600 | <listitem><para>Show terse runtime |
| 601 | status information about one or more | |
| 5c3246b1 LP |
602 | units, followed by its most recent log |
| 603 | data from the journal. This function | |
| 604 | is intended to generate human-readable | |
| 605 | output. If you are looking for | |
| 606 | computer-parsable output, use | |
| 607 | <command>show</command> instead. If a | |
| 608 | PID is passed information about the | |
| 609 | unit the process of the PID belongs to | |
| 610 | is shown.</para></listitem> | |
| 61cbdc4b | 611 | </varlistentry> |
| 393a2f9b LP |
612 | <varlistentry> |
| 613 | <term><command>show [NAME...|JOB...]</command></term> | |
| 614 | ||
| ee5762e3 LP |
615 | <listitem><para>Show properties of one |
| 616 | or more units, jobs or the manager | |
| 393a2f9b | 617 | itself. If no argument is specified |
| 61cbdc4b | 618 | properties of the manager will be |
| 393a2f9b | 619 | shown. If a unit name is specified |
| ee5762e3 LP |
620 | properties of the unit is shown, and |
| 621 | if a job id is specified properties of | |
| 622 | the job is shown. By default, empty | |
| 623 | properties are suppressed. Use | |
| 624 | <option>--all</option> to show those | |
| 625 | too. To select specific properties to | |
| 626 | show use | |
| 627 | <option>--property=</option>. This | |
| 628 | command is intended to be used | |
| 629 | whenever computer-parsable output is | |
| 630 | required. Use | |
| 631 | <command>status</command> if you are | |
| 632 | looking for formatted human-readable | |
| 633 | output.</para></listitem> | |
| 393a2f9b | 634 | </varlistentry> |
| 256425cc | 635 | <varlistentry> |
| b43f208f | 636 | <term><command>help [NAME...|PID...]</command></term> |
| 5632e374 | 637 | |
| 256425cc LP |
638 | <listitem><para>Show manual pages for |
| 639 | one or more units, if available. If a | |
| 640 | PID is passed the manual pages for the | |
| 641 | unit the process of the PID belongs to | |
| 642 | is shown.</para></listitem> | |
| 643 | </varlistentry> | |
| 5632e374 | 644 | <varlistentry> |
| 74ac3cbd MM |
645 | <term><command>reset-failed [NAME...]</command></term> |
| 646 | ||
| 647 | <listitem><para>Reset the | |
| 648 | '<literal>failed</literal>' state of the | |
| 649 | specified units, or if no unit name is | |
| 650 | passed of all units. When a unit fails | |
| 651 | in some way (i.e. process exiting with | |
| 652 | non-zero error code, terminating | |
| 653 | abnormally or timing out) it will | |
| 654 | automatically enter the | |
| 655 | '<literal>failed</literal>' state and | |
| 656 | its exit code and status is recorded | |
| 657 | for introspection by the administrator | |
| 5632e374 LP |
658 | until the service is restarted or |
| 659 | reset with this | |
| 660 | command.</para></listitem> | |
| 661 | </varlistentry> | |
| 662 | ||
| 7e13bea0 RB |
663 | <varlistentry> |
| 664 | <term><command>list-unit-files</command></term> | |
| 665 | ||
| 666 | <listitem><para>List installed unit files. | |
| 667 | </para></listitem> | |
| 668 | </varlistentry> | |
| 669 | ||
| ee5762e3 LP |
670 | <varlistentry> |
| 671 | <term><command>enable [NAME...]</command></term> | |
| 672 | ||
| 673 | <listitem><para>Enable one or more | |
| 674 | unit files, as specified on the | |
| 675 | command line. This will create a | |
| 676 | number of symlinks as encoded in the | |
| 677 | <literal>[Install]</literal> sections | |
| 678 | of the unit files. After the symlinks | |
| 679 | have been created the systemd | |
| 680 | configuration is reloaded (in a way | |
| 681 | that is equivalent to | |
| 682 | <command>daemon-reload</command>) to | |
| 683 | ensure the changes are taken into | |
| 684 | account immediately. Note that this | |
| 685 | does not have the effect that any of | |
| 686 | the units enabled are also started at | |
| 687 | the same time. If this is desired a | |
| 96d4ce01 | 688 | separate <command>start</command> |
| ee5762e3 LP |
689 | command must be invoked for the |
| 690 | unit.</para> | |
| 691 | ||
| 692 | <para>This command will | |
| 693 | print the actions executed. This | |
| 694 | output may be suppressed by passing | |
| 695 | <option>--quiet</option>.</para> | |
| 696 | ||
| 697 | <para>Note that this operation creates | |
| 698 | only the suggested symlinks for the | |
| 699 | units. While this command is the | |
| 700 | recommended way to manipulate the unit | |
| 701 | configuration directory, the | |
| 702 | administrator is free to make | |
| 703 | additional changes manually, by | |
| 704 | placing or removing symlinks in the | |
| 3d428115 | 705 | directory. This is particularly useful |
| ee5762e3 LP |
706 | to create configurations that deviate |
| 707 | from the suggested default | |
| 708 | installation. In this case the | |
| 709 | administrator must make sure to invoke | |
| 710 | <command>daemon-reload</command> | |
| 711 | manually as necessary, to ensure his | |
| 712 | changes are taken into account.</para> | |
| 713 | ||
| 714 | <para>Enabling units should not be | |
| 715 | confused with starting (activating) | |
| 716 | units, as done by the | |
| 717 | <command>start</command> | |
| 718 | command. Enabling and starting units | |
| 719 | is orthogonal: units may be enabled | |
| 720 | without being started and started | |
| 721 | without being enabled. Enabling simply | |
| 722 | hooks the unit into various suggested | |
| 723 | places (for example, so that the unit | |
| 724 | is automatically started on boot or | |
| 725 | when a particular kind of hardware is | |
| 726 | plugged in). Starting actually spawns | |
| 727 | the daemon process (in case of service | |
| 728 | units), or binds the socket (in case | |
| 729 | of socket units), and so | |
| 730 | on.</para> | |
| 731 | ||
| 732 | <para>Depending on whether | |
| 733 | <option>--system</option>, | |
| af2d49f7 | 734 | <option>--user</option> or |
| ee5762e3 LP |
735 | <option>--global</option> is specified |
| 736 | this enables the unit for the system, | |
| af2d49f7 LP |
737 | for the calling user only |
| 738 | or for all future logins of all | |
| ee5762e3 LP |
739 | users. Note that in the latter case no |
| 740 | systemd daemon configuration is | |
| 741 | reloaded.</para> | |
| 742 | </listitem> | |
| 743 | </varlistentry> | |
| 744 | ||
| 745 | <varlistentry> | |
| 746 | <term><command>disable [NAME...]</command></term> | |
| 747 | ||
| 748 | <listitem><para>Disables one or more | |
| 749 | units. This removes all symlinks to | |
| 750 | the specified unit files from the unit | |
| 751 | configuration directory, and hence | |
| 752 | undoes the changes made by | |
| 753 | <command>enable</command>. Note | |
| 729e3769 | 754 | however that this removes |
| ee5762e3 LP |
755 | all symlinks to the unit files |
| 756 | (i.e. including manual additions), not | |
| 757 | just those actually created by | |
| 729e3769 | 758 | <command>enable</command>. This call |
| ee5762e3 LP |
759 | implicitly reloads the systemd daemon |
| 760 | configuration after completing the | |
| 761 | disabling of the units. Note that this | |
| 762 | command does not implicitly stop the | |
| 763 | units that is being disabled. If this | |
| 764 | is desired an additional | |
| 6a2857e6 | 765 | <command>stop</command> command should |
| ee5762e3 LP |
766 | be executed afterwards.</para> |
| 767 | ||
| 768 | <para>This command will print the | |
| 769 | actions executed. This output may be | |
| 770 | suppressed by passing | |
| 771 | <option>--quiet</option>.</para> | |
| 772 | </listitem> | |
| 773 | ||
| 3d428115 | 774 | <para>This command honors |
| ee5762e3 | 775 | <option>--system</option>, |
| af2d49f7 | 776 | <option>--user</option>, |
| ee5762e3 LP |
777 | <option>--global</option> in a similar |
| 778 | way as | |
| 779 | <command>enable</command>.</para> | |
| 780 | </varlistentry> | |
| 781 | ||
| 782 | <varlistentry> | |
| 783 | <term><command>is-enabled [NAME...]</command></term> | |
| 784 | ||
| 785 | <listitem><para>Checks whether any of | |
| 786 | the specified unit files is enabled | |
| 787 | (as with | |
| 788 | <command>enable</command>). Returns an | |
| 789 | exit code of 0 if at least one is | |
| 729e3769 LP |
790 | enabled, non-zero otherwise. Prints |
| 791 | the current enable status. To suppress | |
| 792 | this output use | |
| 793 | <option>--quiet</option>.</para></listitem> | |
| 794 | </varlistentry> | |
| 795 | ||
| 796 | <varlistentry> | |
| 797 | <term><command>reenable [NAME...]</command></term> | |
| 798 | ||
| 799 | <listitem><para>Reenable one or more | |
| 800 | unit files, as specified on the | |
| 801 | command line. This is a combination of | |
| 802 | <command>disable</command> and | |
| 803 | <command>enable</command> and is | |
| 804 | useful to reset the symlinks a unit is | |
| 805 | enabled with to the defaults | |
| 806 | configured in the | |
| 807 | <literal>[Install]</literal> section | |
| 808 | of the unit file.</para> | |
| 809 | </listitem> | |
| 810 | </varlistentry> | |
| 811 | ||
| 812 | <varlistentry> | |
| 813 | <term><command>preset [NAME...]</command></term> | |
| 814 | ||
| 815 | <listitem><para>Reset one or more unit | |
| 816 | files, as specified on the command | |
| 75d67e68 LP |
817 | line, to the defaults configured in |
| 818 | the preset policy files. This has the | |
| 819 | same effect as | |
| 820 | <command>disable</command> or | |
| 729e3769 LP |
821 | <command>enable</command>, depending |
| 822 | how the unit is listed in the preset | |
| 75d67e68 | 823 | files. For more information on preset |
| 99800333 LP |
824 | policy format see |
| 825 | <citerefentry><refentrytitle>systemd.preset</refentrytitle><manvolnum>5</manvolnum></citerefentry>. For | |
| 826 | more information on the concept of | |
| 827 | presets please consult the <ulink | |
| 828 | url="http://freedesktop.org/wiki/Software/systemd/Preset">Preset</ulink> | |
| 829 | document.</para> | |
| 729e3769 LP |
830 | </listitem> |
| 831 | </varlistentry> | |
| 832 | ||
| 833 | <varlistentry> | |
| 834 | <term><command>mask [NAME...]</command></term> | |
| 835 | ||
| 836 | <listitem><para>Mask one or more unit | |
| 837 | files, as specified on the command | |
| 838 | line. This will link these units to | |
| 839 | <filename>/dev/null</filename>, making | |
| 840 | it impossible to start them. This is a stronger version | |
| 841 | of <command>disable</command>, since | |
| 842 | it prohibits all kinds of activation | |
| 843 | of the unit, including manual | |
| 844 | activation. Use this option with | |
| 845 | care.</para> | |
| 846 | </listitem> | |
| 847 | </varlistentry> | |
| 848 | ||
| 849 | <varlistentry> | |
| 850 | <term><command>unmask [NAME...]</command></term> | |
| 851 | ||
| 852 | <listitem><para>Unmask one or more | |
| 853 | unit files, as specified on the | |
| 854 | command line. This will undo the | |
| 855 | effect of | |
| 856 | <command>mask</command>.</para> | |
| 857 | </listitem> | |
| 858 | </varlistentry> | |
| 859 | ||
| 860 | <varlistentry> | |
| 861 | <term><command>link [NAME...]</command></term> | |
| 862 | ||
| 863 | <listitem><para>Link a unit file that | |
| 864 | is not in the unit file search paths | |
| 865 | into the unit file search path. This | |
| 866 | requires an absolute path to a unit | |
| 867 | file. The effect of this can be undone | |
| 868 | with <command>disable</command>. The | |
| 869 | effect of this command is that a unit | |
| 870 | file is available for | |
| 871 | <command>start</command> and other | |
| 872 | commands although it isn't installed | |
| 873 | directly in the unit search | |
| 874 | path.</para> | |
| 875 | </listitem> | |
| ee5762e3 LP |
876 | </varlistentry> |
| 877 | ||
| 393a2f9b LP |
878 | <varlistentry> |
| 879 | <term><command>load [NAME...]</command></term> | |
| 880 | ||
| 881 | <listitem><para>Load one or more units | |
| 882 | specified on the command line. This | |
| 883 | will simply load their configuration | |
| 884 | from disk, but not start them. To | |
| 885 | start them you need to use the | |
| 886 | <command>start</command> command which | |
| 887 | will implicitly load a unit that has | |
| 888 | not been loaded yet. Note that systemd | |
| 889 | garbage collects loaded units that are | |
| 890 | not active or referenced by an active | |
| 891 | unit. This means that units loaded | |
| 892 | this way will usually not stay loaded | |
| 893 | for long. Also note that this command | |
| 894 | cannot be used to reload unit | |
| 895 | configuration. Use the | |
| 896 | <command>daemon-reload</command> | |
| 897 | command for that. All in all, this | |
| 898 | command is of little use except for | |
| 899 | debugging.</para> | |
| 900 | <para>This command should not be | |
| 901 | confused with the | |
| 902 | <command>daemon-reload</command> or | |
| 903 | <command>reload</command> | |
| 904 | commands.</para></listitem> | |
| 905 | </varlistentry> | |
| 906 | <varlistentry> | |
| 907 | <term><command>list-jobs</command></term> | |
| 908 | ||
| 909 | <listitem><para>List jobs that are in progress.</para></listitem> | |
| 910 | </varlistentry> | |
| 911 | <varlistentry> | |
| 912 | <term><command>cancel [JOB...]</command></term> | |
| 913 | ||
| 914 | <listitem><para>Cancel one or more | |
| 915 | jobs specified on the command line by | |
| 916 | their numeric job | |
| 3d428115 | 917 | IDs. If no job id is specified, cancel all pending jobs.</para></listitem> |
| 393a2f9b | 918 | </varlistentry> |
| 7874bcd6 LP |
919 | <varlistentry> |
| 920 | <term><command>dump</command></term> | |
| 921 | ||
| 922 | <listitem><para>Dump server | |
| 923 | status. This will output a (usually | |
| 924 | very long) human readable manager | |
| 925 | status dump. Its format is subject to | |
| 926 | change without notice and should not | |
| 927 | be parsed by | |
| 928 | applications.</para></listitem> | |
| 929 | </varlistentry> | |
| 4445a875 LP |
930 | <varlistentry> |
| 931 | <term><command>dot</command></term> | |
| 932 | ||
| 933 | <listitem><para>Generate textual | |
| 934 | dependency graph description in dot | |
| 935 | format for further processing with the | |
| 936 | GraphViz | |
| 937 | <citerefentry><refentrytitle>dot</refentrytitle><manvolnum>1</manvolnum></citerefentry> | |
| 938 | tool. Use a command line like | |
| 939 | <command>systemctl dot | dot -Tsvg > | |
| 940 | systemd.svg</command> to generate a | |
| 941 | graphical dependency tree. Unless | |
| 942 | <option>--order</option> or | |
| 943 | <option>--require</option> is passed | |
| 944 | the generated graph will show both | |
| 945 | ordering and requirement | |
| 946 | dependencies.</para></listitem> | |
| 947 | </varlistentry> | |
| 7874bcd6 LP |
948 | <varlistentry> |
| 949 | <term><command>snapshot [NAME]</command></term> | |
| 950 | ||
| 951 | <listitem><para>Create a snapshot. If | |
| af62c704 | 952 | a snapshot name is specified, the new |
| 7874bcd6 LP |
953 | snapshot will be named after it. If |
| 954 | none is specified an automatic | |
| 955 | snapshot name is generated. In either | |
| 7594fb25 LP |
956 | case, the snapshot name used is |
| 957 | printed to STDOUT, unless | |
| 958 | <option>--quiet</option> is | |
| 959 | specified.</para> | |
| 7874bcd6 LP |
960 | |
| 961 | <para>A snapshot refers to a saved | |
| 962 | state of the systemd manager. It is | |
| 3d428115 | 963 | implemented itself as a unit that is |
| 7874bcd6 LP |
964 | generated dynamically with this |
| 965 | command and has dependencies on all | |
| 966 | units active at the time. At a later | |
| 967 | time the user may return to this state | |
| 968 | by using the | |
| 969 | <command>isolate</command> command on | |
| 970 | the snapshot unit.</para></listitem> | |
| 971 | ||
| 972 | <para>Snapshots are only useful for | |
| 973 | saving and restoring which units are | |
| 974 | running or are stopped, they do not | |
| 975 | save/restore any other | |
| 976 | state. Snapshots are dynamic and lost | |
| 977 | on reboot.</para> | |
| 978 | </varlistentry> | |
| 979 | <varlistentry> | |
| 6759e7a7 LP |
980 | <term><command>delete [NAME...]</command></term> |
| 981 | ||
| 982 | <listitem><para>Remove a snapshot | |
| 983 | previously created with | |
| 984 | <command>snapshot</command>.</para></listitem> | |
| 985 | </varlistentry> | |
| 986 | <varlistentry> | |
| 7874bcd6 LP |
987 | <term><command>daemon-reload</command></term> |
| 988 | ||
| 989 | <listitem><para>Reload systemd manager | |
| 990 | configuration. This will reload all | |
| 991 | unit files and recreate the entire | |
| 992 | dependency tree. While the daemon is | |
| af62c704 | 993 | reloaded, all sockets systemd listens |
| ad678a06 | 994 | on on behalf of user configuration will |
| 7874bcd6 LP |
995 | stay accessible.</para> <para>This |
| 996 | command should not be confused with | |
| 997 | the <command>load</command> or | |
| 998 | <command>reload</command> | |
| 999 | commands.</para></listitem> | |
| 1000 | </varlistentry> | |
| 1001 | <varlistentry> | |
| 1002 | <term><command>daemon-reexec</command></term> | |
| 1003 | ||
| 1004 | <listitem><para>Reexecute the systemd | |
| 1005 | manager. This will serialize the | |
| 1006 | manager state, reexecute the process | |
| 1007 | and deserialize the state again. This | |
| 1008 | command is of little use except for | |
| 1009 | debugging and package | |
| 1010 | upgrades. Sometimes it might be | |
| 1011 | helpful as a heavy-weight | |
| 1012 | <command>daemon-reload</command>. While | |
| 1013 | the daemon is reexecuted all sockets | |
| 1014 | systemd listens on on behalf of user | |
| 1015 | configuration will stay | |
| 1016 | accessible.</para></listitem> | |
| 1017 | </varlistentry> | |
| 7874bcd6 LP |
1018 | <varlistentry> |
| 1019 | <term><command>show-environment</command></term> | |
| 1020 | ||
| 1021 | <listitem><para>Dump the systemd | |
| 1022 | manager environment block. The | |
| 1023 | environment block will be dumped in | |
| 1024 | straight-forward form suitable for | |
| 1025 | sourcing into a shell script. This | |
| 1026 | environment block will be passed to | |
| 1027 | all processes the manager | |
| 1028 | spawns.</para></listitem> | |
| 1029 | </varlistentry> | |
| 1030 | <varlistentry> | |
| 1031 | <term><command>set-environment [NAME=VALUE...]</command></term> | |
| 1032 | ||
| 1033 | <listitem><para>Set one or more | |
| 1034 | systemd manager environment variables, | |
| 1035 | as specified on the command | |
| 1036 | line.</para></listitem> | |
| 1037 | </varlistentry> | |
| 1038 | <varlistentry> | |
| 1039 | <term><command>unset-environment [NAME...]</command></term> | |
| 1040 | ||
| 1041 | <listitem><para>Unset one or more | |
| 1042 | systemd manager environment | |
| 1043 | variables. If only a variable name is | |
| 1044 | specified it will be removed | |
| 1045 | regardless of its value. If a variable | |
| 1046 | and a value are specified the variable | |
| 1047 | is only removed if it has the | |
| 1048 | specified value.</para></listitem> | |
| 1049 | </varlistentry> | |
| 59cddb23 LP |
1050 | <varlistentry> |
| 1051 | <term><command>default</command></term> | |
| 1052 | ||
| 1053 | <listitem><para>Enter default | |
| 1054 | mode. This is mostly equivalent to | |
| 1055 | <command>start | |
| 1056 | default.target</command>.</para></listitem> | |
| 1057 | </varlistentry> | |
| 1058 | <varlistentry> | |
| 1059 | <term><command>rescue</command></term> | |
| 1060 | ||
| 1061 | <listitem><para>Enter rescue | |
| 1062 | mode. This is mostly equivalent to | |
| 1063 | <command>isolate | |
| 1064 | rescue.target</command> but also | |
| 1065 | prints a wall message to all | |
| 1066 | users.</para></listitem> | |
| 1067 | </varlistentry> | |
| 1068 | <varlistentry> | |
| 1069 | <term><command>emergency</command></term> | |
| 7874bcd6 | 1070 | |
| 59cddb23 LP |
1071 | <listitem><para>Enter emergency |
| 1072 | mode. This is mostly equivalent to | |
| 1073 | <command>isolate | |
| 1074 | emergency.target</command> but also | |
| 1075 | prints a wall message to all | |
| 1076 | users.</para></listitem> | |
| 1077 | </varlistentry> | |
| 7874bcd6 LP |
1078 | <varlistentry> |
| 1079 | <term><command>halt</command></term> | |
| 1080 | ||
| 1081 | <listitem><para>Shut down and halt the | |
| 1082 | system. This is mostly equivalent to | |
| 1083 | <command>start halt.target</command> | |
| 1084 | but also prints a wall message to all | |
| e606bb61 LP |
1085 | users. If combined with |
| 1086 | <option>--force</option> shutdown of | |
| 1087 | all running services is skipped, | |
| 1088 | however all processes are killed and | |
| 1089 | all file systems are unmounted or | |
| 59cddb23 | 1090 | mounted read-only, immediately |
| e606bb61 LP |
1091 | followed by the system halt. If |
| 1092 | <option>--force</option> is specified | |
| 1093 | twice the the operation is immediately | |
| 1094 | executed without terminating any | |
| 1095 | processes or unmounting any file | |
| 1096 | systems. This may result in data | |
| 1097 | loss.</para></listitem> | |
| 7874bcd6 LP |
1098 | </varlistentry> |
| 1099 | <varlistentry> | |
| 1100 | <term><command>poweroff</command></term> | |
| 1101 | ||
| 1102 | <listitem><para>Shut down and | |
| 1103 | power-off the system. This is mostly | |
| 1104 | equivalent to <command>start | |
| 1105 | poweroff.target</command> but also | |
| e606bb61 | 1106 | prints a wall message to all users. If |
| 59cddb23 LP |
1107 | combined with <option>--force</option> |
| 1108 | shutdown of all running services is | |
| e606bb61 LP |
1109 | skipped, however all processes are |
| 1110 | killed and all file systems are | |
| 1111 | unmounted or mounted read-only, | |
| 1112 | immediately followed by the powering | |
| 1113 | off. If <option>--force</option> is | |
| 1114 | specified twice the the operation is | |
| 1115 | immediately executed without | |
| 1116 | terminating any processes or | |
| 1117 | unmounting any file systems. This may | |
| 1118 | result in data loss.</para></listitem> | |
| 7874bcd6 LP |
1119 | </varlistentry> |
| 1120 | <varlistentry> | |
| 1121 | <term><command>reboot</command></term> | |
| 1122 | ||
| e606bb61 LP |
1123 | <listitem><para>Shut down and reboot |
| 1124 | the system. This is mostly equivalent | |
| 1125 | to <command>start | |
| 7874bcd6 | 1126 | reboot.target</command> but also |
| e606bb61 | 1127 | prints a wall message to all users. If |
| 59cddb23 LP |
1128 | combined with <option>--force</option> |
| 1129 | shutdown of all running services is | |
| e606bb61 LP |
1130 | skipped, however all processes are |
| 1131 | killed and all file systems are | |
| 1132 | unmounted or mounted read-only, | |
| 1133 | immediately followed by the reboot. If | |
| 1134 | <option>--force</option> is specified | |
| 1135 | twice the the operation is immediately | |
| 1136 | executed without terminating any | |
| 1137 | processes or unmounting any file | |
| 1138 | systems. This may result in data | |
| 1139 | loss.</para></listitem> | |
| 7874bcd6 LP |
1140 | </varlistentry> |
| 1141 | <varlistentry> | |
| 59cddb23 | 1142 | <term><command>kexec</command></term> |
| 7874bcd6 | 1143 | |
| 59cddb23 LP |
1144 | <listitem><para>Shut down and reboot |
| 1145 | the system via kexec. This is mostly | |
| 1146 | equivalent to <command>start | |
| 1147 | kexec.target</command> but also prints | |
| 1148 | a wall message to all users. If | |
| 1149 | combined with <option>--force</option> | |
| 1150 | shutdown of all running services is | |
| 3d428115 RB |
1151 | skipped, however all processes are killed |
| 1152 | and all file systems are unmounted or | |
| 59cddb23 LP |
1153 | mounted read-only, immediately |
| 1154 | followed by the | |
| 1155 | reboot.</para></listitem> | |
| 7874bcd6 LP |
1156 | </varlistentry> |
| 1157 | <varlistentry> | |
| 59cddb23 | 1158 | <term><command>exit</command></term> |
| 7874bcd6 | 1159 | |
| 59cddb23 LP |
1160 | <listitem><para>Ask the systemd |
| 1161 | manager to quit. This is only | |
| af2d49f7 | 1162 | supported for user service managers |
| 59cddb23 | 1163 | (i.e. in conjunction with the |
| af2d49f7 | 1164 | <option>--user</option> option) and |
| 59cddb23 | 1165 | will fail otherwise.</para></listitem> |
| 7874bcd6 | 1166 | </varlistentry> |
| 6edd7d0a LP |
1167 | <varlistentry> |
| 1168 | <term><command>suspend</command></term> | |
| 1169 | ||
| 1170 | <listitem><para>Suspend the system.</para></listitem> | |
| 1171 | </varlistentry> | |
| 1172 | <varlistentry> | |
| 1173 | <term><command>hibernate</command></term> | |
| 1174 | ||
| 1175 | <listitem><para>Hibernate the system.</para></listitem> | |
| 1176 | </varlistentry> | |
| 957eb8ca LP |
1177 | <varlistentry> |
| 1178 | <term><command>switch-root [ROOT] [INIT]</command></term> | |
| 1179 | ||
| 1180 | <listitem><para>Switches to a | |
| 1181 | different root directory and executes | |
| 1182 | a new system manager process below | |
| 1183 | it. This is intended for usage in | |
| 1184 | initial RAM disks ("initrd"), and will | |
| 1185 | transition from the initrd's system | |
| 1186 | manager process (a.k.a "init" process) | |
| 1187 | to the main system manager | |
| 1188 | process. Takes two arguments: the | |
| 1189 | directory to make the new root | |
| 1190 | directory, and the path to the new | |
| 1191 | system manager binary below it to | |
| 1192 | execute as PID 1. If the latter is | |
| 1193 | ommitted or the empty string, a | |
| 1194 | systemd binary will automatically be | |
| 1195 | searched for and used as init. If the | |
| 1196 | system manager path is ommitted or | |
| 1197 | equal the empty string the state of | |
| 1198 | the initrd's system manager process is | |
| 1199 | passed to the main system manager, | |
| 1200 | which allows later introspection of the | |
| 1201 | state of the services involved in the | |
| 1202 | initrd boot.</para></listitem> | |
| 1203 | </varlistentry> | |
| 7874bcd6 LP |
1204 | </variablelist> |
| 1205 | ||
| 1206 | </refsect1> | |
| 1207 | ||
| 1208 | <refsect1> | |
| 1209 | <title>Exit status</title> | |
| 1210 | ||
| 1211 | <para>On success 0 is returned, a non-zero failure | |
| 1212 | code otherwise.</para> | |
| 1213 | </refsect1> | |
| 1214 | ||
| abebb5af VS |
1215 | <refsect1> |
| 1216 | <title>Environment</title> | |
| 1217 | ||
| 1218 | <variablelist> | |
| 1219 | <varlistentry> | |
| 1220 | <term><varname>$SYSTEMD_PAGER</varname></term> | |
| 1221 | <listitem><para>Pager to use when | |
| 1222 | <option>--no-pager</option> is not given; | |
| 1223 | overrides <varname>$PAGER</varname>. Setting | |
| 1224 | this to an empty string or the value | |
| 1225 | <literal>cat</literal> is equivalent to passing | |
| 1226 | <option>--no-pager</option>.</para></listitem> | |
| 1227 | </varlistentry> | |
| 1228 | </variablelist> | |
| 1229 | </refsect1> | |
| 1230 | ||
| 7874bcd6 LP |
1231 | <refsect1> |
| 1232 | <title>See Also</title> | |
| 1233 | <para> | |
| 1234 | <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>, | |
| 1235 | <citerefentry><refentrytitle>systemadm</refentrytitle><manvolnum>1</manvolnum></citerefentry>, | |
| 169c4f65 LP |
1236 | <citerefentry><refentrytitle>journalctl</refentrytitle><manvolnum>1</manvolnum></citerefentry>, |
| 1237 | <citerefentry><refentrytitle>loginctl</refentrytitle><manvolnum>1</manvolnum></citerefentry>, | |
| 7874bcd6 LP |
1238 | <citerefentry><refentrytitle>systemd.unit</refentrytitle><manvolnum>5</manvolnum></citerefentry>, |
| 1239 | <citerefentry><refentrytitle>systemd.special</refentrytitle><manvolnum>7</manvolnum></citerefentry>, | |
| 75d67e68 LP |
1240 | <citerefentry><refentrytitle>wall</refentrytitle><manvolnum>1</manvolnum></citerefentry>, |
| 1241 | <citerefentry><refentrytitle>systemd.preset</refentrytitle><manvolnum>5</manvolnum></citerefentry> | |
| 7874bcd6 LP |
1242 | </para> |
| 1243 | </refsect1> | |
| 1244 | ||
| 1245 | </refentry> |