opsengine/cpulimit

Why not include usage doc in README?

vikyd opened this issue · 2 comments

vikyd commented

command:

./cpulimit -h

ouput:

Usage: cpulimit [OPTIONS...] TARGET
   OPTIONS
      -l, --limit=N          percentage of cpu allowed from 0 to 800 (required)
      -v, --verbose          show control statistics
      -z, --lazy             exit if there is no target process, or if it dies
      -i, --include-children limit also the children processes
      -h, --help             display this help and exit
   TARGET must be exactly one of these:
      -p, --pid=N            pid of the process (implies -z)
      -e, --exe=FILE         name of the executable program file or path name
      COMMAND [ARGS]         run this command and limit it (implies -z)

Report bugs to <marlonx80@hotmail.com>.

Why not include this usage doc in README?

beroal commented

I guess, to avoid duplication. If the info is in two places, you need to synchronize them.

jvimedia commented

Maybe a reference to where to find the usage info then might be an adequate solution?

  • 👍2