summaryrefslogtreecommitdiff
path: root/Completion/Unix/Command/_pv
blob: 0e1f148d59278af198536694ef6dc7fb8ccb01e8 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
#compdef pv

local curcontext="$curcontext" ign Edesc ret=1
local -a state state_descr line expl suf args fmts
local -A opt_args

(( $#words > 2 )) && ign='!'
(( $+words[(r)-[^-]#E*] )) && Edesc=' and only report a read error once per file'
[[ $OSTYPE = linux* ]] && args=(
  '(-d --watchfd)'{-d+,--watchfd=}'[watch file descriptor opened by process]:process\:fd:->pid-fds' \
)

_arguments -s -S $args \
  '(-p --progress -F --format)'{-p,--progress}'[show progress bar]' \
  '(-t --timer -F --format)'{-t,--timer}'[show elapsed time]' \
  '(-e --eta -F --format)'{-e,--eta}'[show estimated time of arrival]' \
  '(-I --fineta -F --format)'{-I,--fineta}'[show absolute estimated time of arrival]' \
  '(-r --rate -F --format)'{-r,--rate}'[show data transfer rate counter]' \
  '(-a --average-rate -F --format)'{-a,--average-rate}'[show data transfer average rate counter]' \
  '(-m --average-rate-window)'{-m+,--average-rate-window=}'[compute average rate over period]:duration (seconds) [30]' \
  '(-b --bytes -8 --bits -F --format)'{-b,--bytes}'[show number of bytes transferred]' \
  '(-8 --bits -b --bytes -F --format)'{-8,--bits}'[show number of bits transferred]' \
  '(-k --si)'{-k,--si}'[treat suffixes as multiples of 1000 rather than 1024]' \
  '(-T --buffer-percent -F --format)'{-T,--buffer-percent}'[show percentage of transfer buffer in use]' \
  '(-A --last-written -F --format)'{-A+,--last-written=}'[show number of bytes last written]:number (bytes)' \
  '(-F --format -p --progress -t --timer -e --eta -I --fineta -r --rate -a --average-rate -b --bytes -T --buffer-percent -A --last-written -F --format)'{-F+,--format=}'[set output format]:format:->formats' \
  '(-n --numeric -f --force)'{-n,--numeric}'[output percentages, not visual information]' \
  '(-q --quiet)'{-q,--quiet}"[don't output any transfer information at all, useful with -L]" \
  '(-W --wait)'{-W,--wait}'[display nothing until first byte transferred]' \
  '(-D --delay-start -R --remote)'{-D+,--delay-start=}'[display nothing until delay has passed]:delay (seconds)' \
  '(-s --size)'{-s+,--size=}'[set estimated data size]: :_numbers -u bytes size K M G T' \
  '(-g --gauge)'{-g,--gauge}'[if size unknown, show rate vs max rate]' \
  '(-l --line-mode -R --remote)'{-l,--line-mode}'[count lines instead of bytes]' \
  '(-0 --null -l --line-mode)'{-0,--null}'[lines are null-terminated]' \
  '(-i --interval)'{-i+,--interval=}'[update every after specified interval]:interval (seconds) [1]' \
  '(-m --average-rate-window)'{-m,--average-rate-window}'[compute average rate over past period]:period (seconds) [30]' \
  '(-w --width)'{-w+,--width}'[assume terminal is specified characters wide]:width' \
  '(-H --height)'{-H+,--height=}'[assume terminal is specified rows high]:height' \
  '(-N --name)'{-N+,--name=}'[prefix visual information with given name]:name' \
  '(-x --extra-display)'{-x+,--extra-display=}'[also send progress to destination]:destination:_sequence - compadd windowtitle processtitle' \
  '(-v --stats)'{-v,--stats}'[output transfer statistics at the end]' \
  '(-f --force -R --remote)'{-f,--force}'[output even if standard error is not a terminal]' \
  '(-c --cursor -R --remote)'{-c,--cursor}'[use cursor positioning escape sequences]' \
  '(-o --output)'{-o+,--output=}'[write output to file instead of stdout]:file:_files' \
  '(-L --rate-limit)'{-L+,--rate-limit=}'[limit transfer rate]: :_numbers -u "bytes per second" rate K M G T' \
  '(-B --buffer-size)'{-B+,--buffer-size=}'[use a buffer size of given size]: :_numbers -u bytes size K M G T' \
  '(-C --no-splice)'{-C,--no-splice}'[never use splice(), always use read/write]' \
  '(-R --remote)*'{-E,--skip-errors}"[skip read errors in input${Edesc}]" \
  '(-Z --error-skip-block)'{-Z+,--error-skip-block=}'[skip whole blocks on errors]: :_numbers -u bytes "block size" K M G T' \
  '(-S --stop-at-size -R --remote)'{-S,--stop-at-size}'[stop after --size bytes have been transferred]' \
  '(-Y --sync)'{-Y,--sync}'[flush cache to disk after every write]' \
  '(-K --direct-io)'{-K,--direct-io}'[use direct I/O to bypass cache]' \
  '(-X --discard)'{-X,--discard}'[discard input instead of writing to output]' \
  '(-U --store-and-forward)'{-U+,--store-and-forward=}'[write all input to file before writing to output]:file:_files' \
  '(-R --remote -c --cursor -l --line-mode -f --force -D --delay-start -E --skip-errors -S --stop-at-size)'{-R+,--remote=}'[update settings of specified process]:process:_pids -m pv' \
  '(-P --pidfile)'{-P+,--pidfile=}'[save process id in a file]:file:_files' \
  "${ign}(- *)"{-h,--help}'[display usage information]' \
  "${ign}(- *)"{-V,--version}'[display version information]' \
  '*:file:_files' && ret=0

case $state in
  formats)
    compset -P '(%?|%<->A|[^%])#'
    fmts=(
      'p:progress bar'
      't:elapsed time'
      'e:estimated time remaining'
      'I:estimated time of completion'
      'r:current data transfer rate'
      'a:average data transfer rate'
      'b:bytes transferred so far'
      'T:percentage of transfer buffer in use'
      'N:name prefix'
      '%:literal %'
    )
    _describe -t format-specifiers 'format specifier' fmts -p % -S ''
  ;;
  pid-fds)
    if compset -P 1 '*:'; then
      _message -e file-descriptors 'file descriptor'
    else
      compset -S ':*' || suf=( -qS : )
      _pids $suf && ret=0
    fi
  ;;
esac

return ret