shell-completion/bash/journalctl

   1 # journalctl(1) completion                                -*- shell-script -*-
   2 # SPDX-License-Identifier: LGPL-2.1+
   3 #
   4 # This file is part of systemd.
   5 #
   6 # Copyright © 2010 Ran Benita
   7 #
   8 # systemd is free software; you can redistribute it and/or modify it
   9 # under the terms of the GNU Lesser General Public License as published by
  10 # the Free Software Foundation; either version 2.1 of the License, or
  11 # (at your option) any later version.
  12 #
  13 # systemd is distributed in the hope that it will be useful, but
  14 # WITHOUT ANY WARRANTY; without even the implied warranty of
  15 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
  16 # General Public License for more details.
  17 #
  18 # You should have received a copy of the GNU Lesser General Public License
  19 # along with systemd; If not, see <http://www.gnu.org/licenses/>.
  20
  21 __contains_word () {
  22     local w word=$1; shift
  23     for w in "$@"; do
  24         [[ $w = "$word" ]] && return
  25     done
  26 }
  27
  28 __get_machines() {
  29     local a b
  30     (machinectl list-images --no-legend --no-pager; machinectl list --no-legend --no-pager; echo ".host") | \
  31         { while read a b; do echo " $a"; done; } | sort -u;
  32 }
  33
  34 __syslog_priorities=(emerg alert crit err warning notice info debug)
  35
  36 _journalctl() {
  37     local field_vals= cur=${COMP_WORDS[COMP_CWORD]} prev=${COMP_WORDS[COMP_CWORD-1]}
  38     local -A OPTS=(
  39         [STANDALONE]='-a --all --full --system --user
  40                       --disk-usage -f --follow --header
  41                       -h --help -l --local -m --merge --no-pager
  42                       --no-tail -q --quiet --setup-keys --verify
  43                       --version --list-catalog --update-catalog --list-boots
  44                       --show-cursor --dmesg -k --pager-end -e -r --reverse
  45                       --utc -x --catalog --no-full --force --dump-catalog
  46                       --flush --rotate --sync --no-hostname -N --fields'
  47         [ARG]='-b --boot -D --directory --file -F --field -t --identifier
  48                       -M --machine -o --output -u --unit --user-unit -p --priority
  49                       --root --case-sensitive'
  50         [ARGUNKNOWN]='-c --cursor --interval -n --lines -S --since -U --until
  51                       --after-cursor --cursor-file --verify-key -g --grep
  52                       --vacuum-size --vacuum-time --vacuum-files --output-fields'
  53     )
  54
  55     # Use the default completion for shell redirect operators
  56     if __contains_word "$prev" '>' '>>' '&>'; then
  57         compopt -o filenames
  58         COMPREPLY=( $(compgen -f -- "$cur") )
  59         return 0;
  60     fi
  61
  62     if __contains_word "$prev" ${OPTS[ARG]} ${OPTS[ARGUNKNOWN]}; then
  63         case $prev in
  64             --boot|-b)
  65                 comps=$(journalctl -F '_BOOT_ID' 2>/dev/null)
  66                 ;;
  67             --directory|-D|--root)
  68                 comps=$(compgen -d -- "$cur")
  69                 compopt -o filenames
  70                 ;;
  71             --file)
  72                 comps=$(compgen -f -- "$cur")
  73                 compopt -o filenames
  74                 ;;
  75             --output|-o)
  76                 comps=$( journalctl --output=help 2>/dev/null )
  77                 ;;
  78             --field|-F)
  79                 comps=$(journalctl --fields | sort 2>/dev/null)
  80                 ;;
  81             --machine|-M)
  82                 comps=$( __get_machines )
  83                 ;;
  84             --priority|-p)
  85                 comps=${__syslog_priorities[*]}
  86                 compopt -o nosort
  87                 ;;
  88             --unit|-u)
  89                 comps=$(journalctl -F '_SYSTEMD_UNIT' 2>/dev/null)
  90                 # Similarly to systemctl, we need to distinguish between
  91                 # escaped and unescaped names in order to be able to correctly
  92                 # complete them. In this particular case, if the name we're
  93                 # trying to complete is unescaped (i.e. foo\x2dbaz), escape
  94                 # it first, so the compgen below works as expected. For more
  95                 # information about these shenanigans see the systemctl
  96                 # completion file
  97                 if ! [[ $cur =~ '\\' ]]; then
  98                     cur="$(printf '%q' $cur)"
  99                 fi
 100                 compopt -o filenames
 101                 ;;
 102             --user-unit)
 103                 comps=$(journalctl -F '_SYSTEMD_USER_UNIT' 2>/dev/null)
 104                 ;;
 105             --identifier|-t)
 106                 comps=$(journalctl -F 'SYSLOG_IDENTIFIER' 2>/dev/null)
 107                 ;;
 108             --case-sensitive)
 109                 comps='yes no'
 110                 ;;
 111             *)
 112                 return 0
 113                 ;;
 114         esac
 115         COMPREPLY=( $(compgen -o filenames -W '$comps' -- "$cur") )
 116         return 0
 117     fi
 118
 119     if [[ $cur = -* ]]; then
 120         COMPREPLY=( $(compgen -W '${OPTS[*]}' -- "$cur") )
 121         return 0
 122     elif [[ $cur = *=* ]]; then
 123         mapfile -t field_vals < <(journalctl -F "${prev%=}" 2>/dev/null)
 124         COMPREPLY=( $(compgen -W '${field_vals[*]}' -- "${cur#=}") )
 125     elif [[ $cur = /dev* ]]; then
 126         compopt -o filenames
 127         COMPREPLY=( $(compgen -f -- "${cur}") )
 128     elif [[ $cur = /* ]]; then
 129         # Append /dev/ to the list of completions, so that
 130         # after typing /<TAB><TAB> the user sees /dev/ as one
 131         # of the alternatives. Later on the rule above will
 132         # take care of showing device files in /dev/.
 133         mapfile -t field_vals < <(journalctl -F "_EXE" 2>/dev/null; echo '/dev/')
 134         COMPREPLY=( $(compgen -W '${field_vals[*]}' -- "${cur}") )
 135         if [[ "${COMPREPLY[@]}" = '/dev/' ]]; then
 136             compopt -o filenames
 137             COMPREPLY=( $(compgen -f -- "${cur}") )
 138         fi
 139     elif [[ $prev = '=' ]]; then
 140         mapfile -t field_vals < <(journalctl -F "${COMP_WORDS[COMP_CWORD-2]}" 2>/dev/null)
 141         COMPREPLY=( $(compgen -W '${field_vals[*]}' -- "$cur") )
 142     else
 143         mapfile -t field_vals < <(journalctl --fields 2>/dev/null)
 144         compopt -o nospace
 145         COMPREPLY=( $(compgen -W '${field_vals[*]}' -S= -- "$cur") )
 146     fi
 147 }
 148
 149 complete -F _journalctl journalctl