Merge branch 'vendor/TNFTP'
[dragonfly.git] / bin / hostname / hostname.1
1 .\" Copyright (c) 1983, 1988, 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. All advertising materials mentioning features or use of this software
13 .\"    must display the following acknowledgement:
14 .\"     This product includes software developed by the University of
15 .\"     California, Berkeley and its contributors.
16 .\" 4. Neither the name of the University nor the names of its contributors
17 .\"    may be used to endorse or promote products derived from this software
18 .\"    without specific prior written permission.
19 .\"
20 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
21 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
22 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
23 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
24 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
25 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
26 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
27 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
28 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
29 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
30 .\" SUCH DAMAGE.
31 .\"
32 .\"     @(#)hostname.1  8.2 (Berkeley) 4/28/95
33 .\" $FreeBSD: src/bin/hostname/hostname.1,v 1.10.2.4 2002/04/22 22:20:29 keramida Exp $
34 .\" $DragonFly: src/bin/hostname/hostname.1,v 1.5 2007/12/16 02:55:37 thomas Exp $
35 .\"
36 .Dd April 28, 1995
37 .Dt HOSTNAME 1
38 .Os
39 .Sh NAME
40 .Nm hostname
41 .Nd set or print name of current host system
42 .Sh SYNOPSIS
43 .Nm
44 .Op Fl s
45 .Op Ar name-of-host | Fl r Ar ip-address | Fl i Ar interface Op Fl 6 | Fl 4
46 .Sh DESCRIPTION
47 The
48 .Nm
49 utility prints the name of the current host.
50 The super-user can set the hostname by supplying an argument;
51 this is usually done at boot time by setting the
52 .Va hostname
53 variable in
54 .Pa /etc/rc.conf .
55 .Pp
56 Options:
57 .Bl -tag -width flag
58 .It Fl s
59 Trim off any domain information from the printed
60 name.
61 .It Fl r
62 Retrieve hostname via ip lookup.
63 The hostname is set to the first (official)
64 name returned for the supplied ip address.
65 Can be an IPv6 or IPv4 address.
66 .It Fl i
67 Retrieve hostname via supplied interface name.
68 .It Fl 6
69 Used in conjunction with
70 .Fl i
71 to select the 1st IPv6 address on the interface.
72 .It Fl 4
73 Used in conjunction with
74 .Fl i
75 to select the 1st IPv4 address on the interface.
76 This is the default and assumed if
77 .Fl 6
78 or
79 .Fl 4
80 is not supplied.
81 .El
82 .Sh SEE ALSO
83 .Xr gethostname 3 ,
84 .Xr rc.conf 5
85 .Sh HISTORY
86 The
87 .Nm
88 command appeared in
89 .Bx 4.2 .