]> git.ipfire.org Git - thirdparty/systemd.git/blame - shell-completion/zsh/_systemctl.in
Use "new" --job-mode= option in more places
[thirdparty/systemd.git] / shell-completion / zsh / _systemctl.in
CommitLineData
ff7a0685
WG
1#compdef systemctl
2
3(( $+functions[_systemctl_command] )) || _systemctl_command()
4{
5 local -a _systemctl_cmds
6 _systemctl_cmds=(
d808ca64 7 "list-sockets:List sockets"
d1811159 8 "list-timers:List timers"
ff7a0685
WG
9 "list-units:List units"
10 "start:Start (activate) one or more units"
11 "stop:Stop (deactivate) one or more units"
12 "reload:Reload one or more units"
13 "restart:Start or restart one or more units"
14 "condrestart:Restart one or more units if active"
15 "try-restart:Restart one or more units if active"
16 "reload-or-restart:Reload one or more units if possible, otherwise start or restart"
17 "force-reload:Reload one or more units if possible, otherwise restart if active"
18 "hibernate:Hibernate the system"
19 "hybrid-sleep:Hibernate and suspend the system"
20 "reload-or-try-restart:Reload one or more units if possible, otherwise restart if active"
21 "isolate:Start one unit and stop all others"
22 "kill:Send signal to processes of a unit"
23 "is-active:Check whether units are active"
24 "is-failed:Check whether units are failed"
25 "status:Show runtime status of one or more units"
26 "show:Show properties of one or more units/jobs or the manager"
6da49b8b 27 "cat:Show the source unit files and drop-ins"
ff7a0685 28 "reset-failed:Reset failed state for all, one, or more units"
ff7a0685
WG
29 "list-unit-files:List installed unit files"
30 "enable:Enable one or more unit files"
31 "disable:Disable one or more unit files"
32 "reenable:Reenable one or more unit files"
33 "preset:Enable/disable one or more unit files based on preset configuration"
1cf3c30c
ZJS
34 "set-default:Set the default target"
35 "get-default:Query the default target"
409886c4 36 "edit:Edit one or more unit files"
1cf3c30c 37 "is-system-running:Query overall status of the system"
ff7a0685
WG
38 "help:Show documentation for specified units"
39 "list-dependencies:Show unit dependency tree"
40 "mask:Mask one or more units"
41 "unmask:Unmask one or more units"
42 "link:Link one or more units files into the search path"
43 "is-enabled:Check whether unit files are enabled"
44 "list-jobs:List jobs"
45 "cancel:Cancel all, one, or more jobs"
ff7a0685
WG
46 "snapshot:Create a snapshot"
47 "delete:Remove one or more snapshots"
48 "show-environment:Dump environment"
49 "set-environment:Set one or more environment variables"
50 "unset-environment:Unset one or more environment variables"
51 "daemon-reload:Reload systemd manager configuration"
52 "daemon-reexec:Reexecute systemd manager"
53 "default:Enter system default mode"
54 "rescue:Enter system rescue mode"
55 "emergency:Enter system emergency mode"
56 "halt:Shut down and halt the system"
57 "suspend:Suspend the system"
58 "poweroff:Shut down and power-off the system"
59 "reboot:Shut down and reboot the system"
60 "kexec:Shut down and reboot the system with kexec"
61 "exit:Ask for user instance termination"
7b742b31 62 "switch-root:Change root directory"
ff7a0685
WG
63 )
64
65 if (( CURRENT == 1 )); then
66 _describe -t commands 'systemctl command' _systemctl_cmds || compadd "$@"
67 else
68 local curcontext="$curcontext"
69
70 cmd="${${_systemctl_cmds[(r)$words[1]:*]%%:*}}"
71 # Deal with any aliases
72 case $cmd in
73 condrestart) cmd="try-restart";;
74 force-reload) cmd="reload-or-try-restart";;
75 esac
76
77 if (( $#cmd )); then
78 curcontext="${curcontext%:*:*}:systemctl-${cmd}:"
79
80 local update_policy
81 zstyle -s ":completion:${curcontext}:" cache-policy update_policy
82 if [[ -z "$update_policy" ]]; then
83 zstyle ":completion:${curcontext}:" cache-policy _systemctl_caching_policy
84 fi
85
86 _call_function ret _systemctl_$cmd || _message 'no more arguments'
87 else
88 _message "unknown systemctl command: $words[1]"
89 fi
90 return ret
91 fi
92}
93
94__systemctl()
95{
96 local -a _modes
97 _modes=("--user" "--system")
98 systemctl ${words:*_modes} --full --no-legend --no-pager "$@"
99}
100
101
102# Fills the unit list
103_systemctl_all_units()
104{
105 if ( [[ ${+_sys_all_units} -eq 0 ]] || _cache_invalid SYS_ALL_UNITS ) &&
106 ! _retrieve_cache SYS_ALL_UNITS;
107 then
6d314eca 108 _sys_all_units=( $(__systemctl list-units --all | { while read -r a b; do echo -E - " $a"; done; }) )
ff7a0685
WG
109 _store_cache SYS_ALL_UNITS _sys_all_units
110 fi
111}
112
113# Fills the unit list including all file units
114_systemctl_really_all_units()
115{
116 local -a all_unit_files;
117 local -a really_all_units;
118 if ( [[ ${+_sys_really_all_units} -eq 0 ]] || _cache_invalid SYS_REALLY_ALL_UNITS ) &&
119 ! _retrieve_cache SYS_REALLY_ALL_UNITS;
120 then
6d314eca 121 all_unit_files=( $(__systemctl list-unit-files | { while read -r a b; do echo -E - " $a"; done; }) )
ff7a0685
WG
122 _systemctl_all_units
123 really_all_units=($_sys_all_units $all_unit_files)
124 _sys_really_all_units=(${(u)really_all_units})
125 _store_cache SYS_REALLY_ALL_UNITS _sys_really_all_units
126 fi
127}
128
129_filter_units_by_property() {
130 local property=$1 value=$2 ; shift ; shift
131 local -a units ; units=($*)
132 local prop unit
133 for ((i=1; $i <= ${#units[*]}; i++)); do
134 # FIXME: "Failed to issue method call: Unknown unit" errors are ignored for
135 # now (related to DBUS_ERROR_UNKNOWN_OBJECT). in the future, we need to
136 # revert to calling 'systemctl show' once for all units, which is way
137 # faster
138 unit=${units[i]}
139 prop=${(f)"$(_call_program units "$service show --no-pager --property="$property" ${unit} 2>/dev/null")"}
140 if [[ "${prop}" = "$property=$value" ]]; then
e37b56c7 141 echo -E - " ${unit}"
ff7a0685
WG
142 fi
143 done
144}
145
e9a19bd8
ZJS
146_systemctl_get_template_names() { __systemctl list-unit-files | { while read -r a b; do [[ $a =~ @\. ]] && echo -E - " ${a%%@.*}@"; done; } }
147
f29c77bc 148
6d314eca 149_systemctl_active_units() {_sys_active_units=( $(__systemctl list-units | { while read -r a b; do echo -E - " $a"; done; }) )}
81333ecf
ZJS
150
151_systemctl_startable_units(){
152 _sys_startable_units=(_filter_units_by_property ActiveState inactive $(
153 _filter_units_by_property CanStart yes $(
154 __systemctl $mode list-unit-files --state enabled,disabled,static | \
155 { while read -r a b; do [[ $a =~ @\. ]] || echo -E - " $a"; done; }
156 __systemctl $mode list-units --state inactive,failed | \
157 { while read -r a b; do echo -E - " $a"; done; } )))
158}
159
160_systemctl_restartable_units(){
161 _sys_restartable_units=(_filter_units_by_property CanStart yes $(
162 __systemctl $mode list-unit-files --state enabled,disabled,static | \
163 { while read -r a b; do [[ $a =~ @\. ]] || echo -E - " $a"; done; }
164 __systemctl $mode list-units | \
165 { while read -r a b; do echo -E - " $a"; done; } ))
166}
167
6d314eca
EC
168_systemctl_failed_units() {_sys_failed_units=( $(__systemctl list-units --failed | { while read -r a b; do echo -E - " $a"; done; }) )}
169_systemctl_enabled_units() {_sys_enabled_units=( $(__systemctl list-unit-files | { while read -r a b; do [[ $b == "enabled" ]] && echo -E - " $a"; done; }) )}
170_systemctl_disabled_units(){_sys_disabled_units=($(__systemctl list-unit-files | { while read -r a b; do [[ $b == "disabled" ]] && echo -E - " $a"; done; }) )}
171_systemctl_masked_units() {_sys_masked_units=( $(__systemctl list-unit-files | { while read -r a b; do [[ $b == "masked" ]] && echo -E - " $a"; done; }) )}
ff7a0685
WG
172
173# Completion functions for ALL_UNITS
409886c4 174for fun in is-active is-failed is-enabled status show cat mask preset help list-dependencies edit ; do
ff7a0685
WG
175 (( $+functions[_systemctl_$fun] )) || _systemctl_$fun()
176 {
177 _systemctl_really_all_units
178 compadd "$@" -a - _sys_really_all_units
179 }
180done
181
182# Completion functions for ENABLED_UNITS
e9a19bd8
ZJS
183(( $+functions[_systemctl_disable] )) || _systemctl_disable()
184{
185 _systemctl_enabled_units
186 compadd "$@" -a - _sys_enabled_units
187}
188
189(( $+functions[_systemctl_reenable] )) || _systemctl_reenable()
190{
ff7a0685
WG
191 _systemctl_enabled_units
192 _systemctl_disabled_units
e9a19bd8
ZJS
193 compadd "$@" -a - _sys_enabled_units _sys_disabled_units $(_systemctl_get_template_names)
194}
ff7a0685
WG
195
196# Completion functions for DISABLED_UNITS
197(( $+functions[_systemctl_enable] )) || _systemctl_enable()
198{
199 _systemctl_disabled_units
e9a19bd8 200 compadd "$@" -a - _sys_disabled_units $(_systemctl_get_template_names)
ff7a0685
WG
201}
202
203# Completion functions for FAILED_UNITS
204(( $+functions[_systemctl_reset-failed] )) || _systemctl_reset-failed()
205{
206 _systemctl_failed_units
207 compadd "$@" -a - _sys_failed_units || _message "no failed unit found"
208}
209
210# Completion functions for STARTABLE_UNITS
211(( $+functions[_systemctl_start] )) || _systemctl_start()
212{
f29c77bc 213 _systemctl_startable_units
81333ecf 214 compadd "$@" - ${_sys_startable_units[*]} $(_systemctl_get_template_names)
ff7a0685
WG
215}
216
217# Completion functions for STOPPABLE_UNITS
218for fun in stop kill try-restart condrestart ; do
219 (( $+functions[_systemctl_$fun] )) || _systemctl_$fun()
220 {
221 _systemctl_active_units
222 compadd "$@" - $( _filter_units_by_property CanStop yes \
223 ${_sys_active_units[*]} )
224 }
225done
226
227# Completion functions for ISOLATABLE_UNITS
228(( $+functions[_systemctl_isolate] )) || _systemctl_isolate()
229{
230 _systemctl_all_units
231 compadd "$@" - $( _filter_units_by_property AllowIsolate yes \
232 ${_sys_all_units[*]} )
233}
234
235# Completion functions for RELOADABLE_UNITS
236for fun in reload reload-or-try-restart force-reload ; do
237 (( $+functions[_systemctl_$fun] )) || _systemctl_$fun()
238 {
239 _systemctl_active_units
240 compadd "$@" - $( _filter_units_by_property CanReload yes \
241 ${_sys_active_units[*]} )
242 }
243done
244
245# Completion functions for RESTARTABLE_UNITS
246for fun in restart reload-or-restart ; do
247 (( $+functions[_systemctl_$fun] )) || _systemctl_$fun()
248 {
f29c77bc 249 _systemctl_restartable_units
81333ecf 250 compadd "$@" - ${_sys_restartable_units[*]} $(_systemctl_get_template_names)
ff7a0685
WG
251 }
252done
253
254# Completion functions for MASKED_UNITS
255(( $+functions[_systemctl_unmask] )) || _systemctl_unmask()
256{
257 _systemctl_masked_units
1cf3c30c 258 compadd "$@" -a - _sys_masked_units || _message "no masked units found"
ff7a0685
WG
259}
260
261# Completion functions for JOBS
262(( $+functions[_systemctl_cancel] )) || _systemctl_cancel()
263{
264 compadd "$@" - $(__systemctl list-jobs \
1cf3c30c 265 | cut -d' ' -f1 2>/dev/null ) || _message "no jobs found"
ff7a0685
WG
266}
267
268# Completion functions for SNAPSHOTS
269(( $+functions[_systemctl_delete] )) || _systemctl_delete()
270{
271 compadd "$@" - $(__systemctl list-units --type snapshot --all \
1cf3c30c
ZJS
272 | cut -d' ' -f1 2>/dev/null ) || _message "no snapshots found"
273}
274
275# Completion functions for TARGETS
276(( $+functions[_systemctl_set-default] )) || _systemctl_set-default()
277{
278 compadd "$@" - $(__systemctl list-unit-files --type target --all \
279 | cut -d' ' -f1 2>/dev/null ) || _message "no targets found"
ff7a0685
WG
280}
281
282# Completion functions for ENVS
283for fun in set-environment unset-environment ; do
284 (( $+functions[_systemctl_$fun] )) || _systemctl_$fun()
285 {
286 local fun=$0 ; fun=${fun##_systemctl_}
287 local suf
288 if [[ "${fun}" = "set-environment" ]]; then
289 suf='-S='
290 fi
291
292 compadd "$@" ${suf} - $(systemctl show-environment \
293 | while read line; do echo " ${line%%\=}";done )
294 }
295done
296
2c12a402
ZJS
297(( $+functions[_systemctl_link] )) || _systemctl_link() {
298 _sd_unit_files
299}
ff7a0685 300
7b742b31
ZJS
301(( $+functions[_systemctl_switch-root] )) || _systemctl_switch-root() {
302 _files
303}
304
ff7a0685 305# no systemctl completion for:
299c397c 306# [STANDALONE]='daemon-reexec daemon-reload default
ff7a0685
WG
307# emergency exit halt kexec list-jobs list-units
308# list-unit-files poweroff reboot rescue show-environment'
f89a4474 309# [NAME]='snapshot'
ff7a0685
WG
310
311_systemctl_caching_policy()
312{
313 local _sysunits
314 local -a oldcache
315
316 # rebuild if cache is more than a day old
317 oldcache=( "$1"(mh+1) )
318 (( $#oldcache )) && return 0
319
320 _sysunits=($(__systemctl --all | cut -d' ' -f1))
321
322 if (( $#_sysunits )); then
323 for unit in $_sysunits; do
324 [[ "$unit" -nt "$1" ]] && return 0
325 done
326 fi
327
328 return 1
329}
330
298b9e23
WG
331_unit_states() {
332 local -a _states
333 _states=(loaded failed active inactive not-found listening running waiting plugged mounted exited dead masked)
334 _values -s , "${_states[@]}"
335}
336
337_unit_types() {
338 local -a _types
2c12a402 339 _types=(automount busname device mount path service snapshot socket swap target timer)
298b9e23
WG
340 _values -s , "${_types[@]}"
341}
342
c0a67aef
ZJS
343_unit_properties() {
344 if ( [[ ${+_sys_all_properties} -eq 0 ]] || _cache_invalid SYS_ALL_PROPERTIES ) &&
345 ! _retrieve_cache SYS_ALL_PROPERTIES;
346 then
347 _sys_all_properties=( $( {__systemctl show --all;
348 @rootlibexecdir@/systemd --dump-configuration-items; } | {
349 while IFS='=' read -r a b; do [ -n "$b" ] && echo "$a"; done
350 }) )
351 _store_cache SYS_ALL_PROPRTIES _sys_all_properties
352 fi
353 _values -s , "${_sys_all_properties[@]}"
354}
355
903e7c37
ZJS
356_job_modes() {
357 local -a _modes
358 _modes=(fail replace replace-irreversibly isolate ignore-dependencies ignore-requirements flush)
359 _values -s , "${_modes[@]}"
360}
361
ff7a0685
WG
362_arguments -s \
363 {-h,--help}'[Show help]' \
364 '--version[Show package version]' \
862f4963 365 {-t+,--type=}'[List only units of a particular type]:unit type:_unit_types' \
903e7c37
ZJS
366 '--state=[Display units in the specified state]:unit state:_unit_states' \
367 '--job-mode=[Specify how to deal with other jobs]:mode:_job_modes' \
c0a67aef 368 {-p+,--property=}'[Show only properties by specific name]:unit property:_unit_properties' \
ff7a0685
WG
369 {-a,--all}'[Show all units/properties, including dead/empty ones]' \
370 '--reverse[Show reverse dependencies]' \
371 '--after[Show units ordered after]' \
372 '--before[Show units ordered before]' \
373 '--failed[Show only failed units]' \
374 {-l,--full}"[Don't ellipsize unit names on output]" \
ff7a0685 375 '--show-types[When showing sockets, show socket type]' \
ff7a0685
WG
376 {-i,--ignore-inhibitors}'[When executing a job, ignore jobs dependencies]' \
377 {-q,--quiet}'[Suppress output]' \
378 '--no-block[Do not wait until operation finished]' \
379 '--no-legend[Do not print a legend, i.e. the column headers and the footer with hints]' \
380 '--no-pager[Do not pipe output into a pager]' \
381 '--system[Connect to system manager]' \
382 '--user[Connect to user service manager]' \
383 "--no-wall[Don't send wall message before halt/power-off/reboot]" \
384 '--global[Enable/disable unit files globally]' \
385 "--no-reload[When enabling/disabling unit files, don't reload daemon configuration]" \
386 '--no-ask-password[Do not ask for system passwords]' \
387 '--kill-who=[Who to send signal to]:killwho:(main control all)' \
862f4963 388 {-s+,--signal=}'[Which signal to send]:signal:_signals' \
ff7a0685
WG
389 {-f,--force}'[When enabling unit files, override existing symlinks. When shutting down, execute action immediately]' \
390 '--root=[Enable unit files in the specified root directory]:directory:_directories' \
391 '--runtime[Enable unit files only temporarily until next reboot]' \
6da49b8b 392 {-H+,--host=}'[Operate on remote host]:userathost:_sd_hosts_or_user_at_host' \
ff7a0685 393 {-P,--privileged}'[Acquire privileges before execution]' \
862f4963 394 {-n+,--lines=}'[Journal entries to show]:number of entries' \
a02c5fe7 395 {-o+,--output=}'[Change journal output mode]:modes:_sd_outputmodes' \
5bdf2243 396 '--firmware-setup[Tell the firmware to show the setup menu on next boot]' \
ff7a0685
WG
397 '--plain[When used with list-dependencies, print output as a list]' \
398 '*::systemctl command:_systemctl_command'