File: ctop.sh
   1 #!/bin/sh
   2 
   3 # The MIT License (MIT)
   4 #
   5 # Copyright © 2025 pacman64
   6 #
   7 # Permission is hereby granted, free of charge, to any person obtaining a copy
   8 # of this software and associated documentation files (the “Software”), to deal
   9 # in the Software without restriction, including without limitation the rights
  10 # to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
  11 # copies of the Software, and to permit persons to whom the Software is
  12 # furnished to do so, subject to the following conditions:
  13 #
  14 # The above copyright notice and this permission notice shall be included in
  15 # all copies or substantial portions of the Software.
  16 #
  17 # THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  18 # IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  19 # FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
  20 # AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  21 # LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
  22 # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
  23 # SOFTWARE.
  24 
  25 
  26 # ctop [seconds...] [options...]
  27 #
  28 #
  29 # Clean TOP runs `top` using better default settings, and offers easier-to-use
  30 # command-line options. Updates happen every 2 seconds by default, unless you
  31 # change it by giving an argument which looks like a number, with or without
  32 # decimals.
  33 #
  34 # The name comes from the fact that regular `top` shows some output when quit,
  35 # while this wrapper tool doesn't.
  36 #
  37 # As when running `top` directly, pressing `q` quits, while pressing `h` shows
  38 # the help screen, which you also quit by pressing `q` while in it. You can
  39 # also force-quit this tool by pressing Ctrl+C.
  40 #
  41 # The options are, available both in single and double-dash versions
  42 #
  43 #   -cpu    reverse-sort entries by latest sampled CPU use
  44 #
  45 #   -h      show this help message
  46 #   -help   show this help message
  47 #
  48 #   -id     sort entries by PID
  49 #   -pid    sort entries by PID
  50 #
  51 #   -m      reverse-sort entries by latest sampled RSS/RES (memory) use
  52 #   -mem    reverse-sort entries by latest sampled RSS/RES (memory) use
  53 #   -res    reverse-sort entries by latest sampled RSS/RES (memory) use
  54 #   -rss    reverse-sort entries by latest sampled RSS/RES (memory) use
  55 #
  56 #   -sh     reverse-sort entries by latest sampled shared memory use
  57 #   -shr    reverse-sort entries by latest sampled shared memory use
  58 #
  59 #   -time   reverse-sort entries by running time
  60 #
  61 #   -usr    sort entries by user
  62 #   -user   sort entries by user
  63 #
  64 #   -vir    reverse-sort entries by latest sampled VIRTual memory use
  65 #   -virt   reverse-sort entries by latest sampled VIRTual memory use
  66 
  67 
  68 case "$1" in
  69     -h|--h|-help|--help)
  70         awk '/^# +ctop /, /^$/ { gsub(/^# ?/, ""); print }' "$0"
  71         exit 0
  72     ;;
  73 esac
  74 
  75 cmd='top'
  76 sort=''
  77 seconds=2
  78 number_regex='^(\.[0-9]+|[1-9]+(\.[0-9]+)?)$'
  79 
  80 for arg in "$@"; do
  81     if [ "${arg}" = '--' ]; then
  82         break
  83     fi
  84 
  85     case "${arg}" in
  86         -cpu|--cpu) sort="-o %CPU";;
  87         -id|--id|-pid|--pid) sort="-o PID";;
  88         -m|--m|-mem|--mem|-res|--res|-rss|--rss) sort="-o RES";;
  89         -sh|--sh|-shr|--shr) sort="-o SHR";;
  90         -t|--t|-time|--time|-time+|--time+) sort="-o TIME+";;
  91         -usr|--usr|-user|--user) sort="-o USER";;
  92         -vir|--vir|-virt|--virt) sort="-o VIRT";;
  93         *)
  94             if echo "${arg}" | grep -E -q "${number_regex}"; then
  95                 seconds="${arg}"
  96             else
  97                 cmd="${cmd} ${arg}"
  98             fi
  99         ;;
 100     esac
 101 done
 102 
 103 # restore previous screen contents when sent an INT signal, which usually
 104 # happens by pressing Ctrl+C
 105 trap 'tput rmcup; exit 130' INT
 106 
 107 tput smcup
 108 ${cmd} -d "${seconds}" ${sort}
 109 code=$?
 110 tput rmcup
 111 exit "${code}"