~sircmpwn/ctools

71ac7a3088d994939482d5157b76f6c360e91017 — Drew DeVault 1 year, 2 months ago 07cc27f
nice: add man page
2 files changed, 31 insertions(+), 0 deletions(-)

M doc/meson.build
A doc/nice.1.scd
M doc/meson.build => doc/meson.build +1 -0
@@ 13,6 13,7 @@ man_files = [
	'comm.1',
	'link.1',
	'logname.1',
	'nice.1',
	'false.1',
	'true.1',
	'unlink.1',

A doc/nice.1.scd => doc/nice.1.scd +30 -0
@@ 0,0 1,30 @@
nice(1) "ctools"

# NAME

nice - run a process with an altered niceness value

# SYNOPSIS

*nice* [-n _incr_] _command_ [_args_...]

# DESCRIPTION

*nice* runs _command_ (with optional _args_) with the niceness adjusted
relative to the current niceness.

Note that on systems where ctools has been compiled without XSI support, *nice*
will run _command_ without setting the niceness.

# OPTIONS

*-n* _incr_
	Specify _incr_ as an integer representing the amount to adjust the
	niceness by, positive or negative. The default adjustement is 10.

# DISCLAIMER

This command is part of ctools and is compatible with POSIX-1.2017, and may
optionally support XSI extensions. This man page is not intended to be a
complete reference, and where it disagrees with the specification, the
specification takes precedence.