xref: /dragonfly/usr.bin/nice/nice.1 (revision 6a3cbbc2)
1.\" Copyright (c) 1980, 1990, 1993
2.\"	The Regents of the University of California.  All rights reserved.
3.\"
4.\" Redistribution and use in source and binary forms, with or without
5.\" modification, are permitted provided that the following conditions
6.\" are met:
7.\" 1. Redistributions of source code must retain the above copyright
8.\"    notice, this list of conditions and the following disclaimer.
9.\" 2. Redistributions in binary form must reproduce the above copyright
10.\"    notice, this list of conditions and the following disclaimer in the
11.\"    documentation and/or other materials provided with the distribution.
12.\" 3. Neither the name of the University nor the names of its contributors
13.\"    may be used to endorse or promote products derived from this software
14.\"    without specific prior written permission.
15.\"
16.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
17.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
18.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
19.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
20.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
21.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
22.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
23.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
24.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
25.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
26.\" SUCH DAMAGE.
27.\"
28.\"	@(#)nice.1	8.1 (Berkeley) 6/6/93
29.\" $FreeBSD: src/usr.bin/nice/nice.1,v 1.12.2.7 2002/12/29 16:35:40 schweikh Exp $
30.\"
31.Dd June 6, 1993
32.Dt NICE 1
33.Os
34.Sh NAME
35.Nm nice
36.Nd execute a utility at an altered scheduling priority
37.Sh SYNOPSIS
38.Nm
39.Op Fl n Ar increment
40.Ar utility
41.Op Ar argument ...
42.Sh DESCRIPTION
43The
44.Nm
45utility runs
46.Ar utility
47at an altered scheduling priority, by incrementing its
48.Dq nice
49value by the specified
50.Ar increment ,
51or a default value of 10.
52The lower the nice value of a process, the higher its scheduling priority.
53.Pp
54The superuser may specify a negative increment in order to run a utility
55with a higher scheduling priority.
56.Pp
57Some shells may provide a builtin
58.Nm
59command which is similar or identical to this utility.
60Consult the
61.Xr builtin 1
62manual page.
63.Sh EXIT STATUS
64If
65.Ar utility
66is invoked, the exit status of
67.Nm
68is the exit status of
69.Ar utility .
70.Pp
71An exit status of 126 indicates
72.Ar utility
73was found, but could not be executed.
74An exit status of 127 indicates
75.Ar utility
76could not be found.
77.Sh EXAMPLES
78$ nice -n 5 date
79.Pp
80Execute utility
81.Sq date
82at priority 5 assuming the priority of the
83shell is 0.
84.Pp
85# nice -n 16 nice -n -35 date
86.Pp
87Execute utility
88.Sq date
89at priority -19 assuming the priority of the
90shell is 0 and you are the super-user.
91.Sh COMPATIBILITY
92The traditional
93.Fl Ns Ar increment
94option has been deprecated but is still supported.
95.Sh SEE ALSO
96.Xr builtin 1 ,
97.Xr csh 1 ,
98.Xr idprio 1 ,
99.Xr rtprio 1 ,
100.Xr getpriority 2 ,
101.Xr setpriority 2 ,
102.Xr renice 8
103.Sh STANDARDS
104The
105.Nm
106utility conforms to
107.St -p1003.1-2001 .
108.Sh HISTORY
109A
110.Nm
111utility appeared in
112.At v4 .
113