Initial import from FreeBSD RELENG_4:
[dragonfly.git] / usr.bin / nohup / nohup.1
1 .\" Copyright (c) 1989, 1990, 1993
2 .\"     The Regents of the University of California.  All rights reserved.
3 .\"
4 .\" This code is derived from software contributed to Berkeley by
5 .\" the Institute of Electrical and Electronics Engineers, Inc.
6 .\"
7 .\" Redistribution and use in source and binary forms, with or without
8 .\" modification, are permitted provided that the following conditions
9 .\" are met:
10 .\" 1. Redistributions of source code must retain the above copyright
11 .\"    notice, this list of conditions and the following disclaimer.
12 .\" 2. Redistributions in binary form must reproduce the above copyright
13 .\"    notice, this list of conditions and the following disclaimer in the
14 .\"    documentation and/or other materials provided with the distribution.
15 .\" 3. All advertising materials mentioning features or use of this software
16 .\"    must display the following acknowledgement:
17 .\"     This product includes software developed by the University of
18 .\"     California, Berkeley and its contributors.
19 .\" 4. Neither the name of the University nor the names of its contributors
20 .\"    may be used to endorse or promote products derived from this software
21 .\"    without specific prior written permission.
22 .\"
23 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
24 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
25 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
26 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
27 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
28 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
29 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
30 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
31 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
32 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
33 .\" SUCH DAMAGE.
34 .\"
35 .\"     @(#)nohup.1     8.1 (Berkeley) 6/6/93
36 .\" $FreeBSD: src/usr.bin/nohup/nohup.1,v 1.6.2.4 2001/08/16 13:16:59 ru Exp $
37 .\"
38 .Dd July 19, 2001
39 .Dt NOHUP 1
40 .Os
41 .Sh NAME
42 .Nm nohup
43 .Nd invoke a command immune to hangups
44 .Sh SYNOPSIS
45 .Nm
46 .Op Fl Fl
47 .Ar command
48 .Op Ar arguments
49 .Sh DESCRIPTION
50 The
51 .Nm
52 utility invokes
53 .Ar command
54 with its
55 .Ar arguments
56 and at this time sets the signal
57 .Dv SIGHUP
58 to be ignored.
59 If the standard output is a terminal, the standard output is
60 appended to the file
61 .Pa nohup.out
62 in the current directory.
63 If standard error is a terminal, it is directed to the same place
64 as the standard output.
65 .Pp
66 Some shells may provide a builtin
67 .Nm
68 command which is similar or identical to this utility.
69 Consult the
70 .Xr builtin 1
71 manual page.
72 .Sh ENVIRONMENT
73 The following variable is utilized by
74 .Nm :
75 .Bl -tag -width flag
76 .It Ev HOME
77 If the output file
78 .Pa nohup.out
79 cannot be created in the current directory, the
80 .Nm
81 utility uses the directory named by
82 .Ev HOME
83 to create the file.
84 .El
85 .Sh DIAGNOSTICS
86 The
87 .Nm
88 utility exits with one of the following values:
89 .Bl -tag -width Ds
90 .It 126
91 The
92 .Ar command
93 was found, but could not be invoked.
94 .It 127
95 The
96 .Ar command
97 could not be found or an error occurred in
98 .Nm .
99 .El
100 .Pp
101 Otherwise, the exit status of
102 .Nm
103 will be that of
104 .Ar command .
105 .Sh SEE ALSO
106 .Xr builtin 1 ,
107 .Xr csh 1 ,
108 .Xr signal 3
109 .Sh STANDARDS
110 The
111 .Nm
112 utility is expected to be
113 .St -p1003.2
114 compatible.
115 .Sh BUGS
116 Two or more instances of
117 .Nm
118 can append to the same file, which makes for a confusing output.