Merge from vendor branch BIND:
[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.4 2004/07/08 00:27:10 hmp 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 | -r ip-address | -i interface [-6 | -4]
46 .Sh DESCRIPTION
47 The
48 .Nm
49 utility prints the name of the current host.  The super-user can
50 set the hostname by supplying an argument; this is usually done in the
51 network initialization script
52 .Pa /etc/rc.network ,
53 normally run at boot
54 time.
55 This script uses the
56 .Va hostname
57 variable in
58 .Pa /etc/rc.conf .
59 .Pp
60 Options:
61 .Bl -tag -width flag
62 .It Fl s
63 Trim off any domain information from the printed
64 name.
65 .It Fl r
66 Retrieve hostname via ip lookup.  The hostname is set to the first (official)
67 name returned for the supplied ip address.  Can be an IPv6 or IPv4 address.
68 .It Fl i
69 Retrieve hostname via supplied interface name.
70 .It Fl 6
71 Used in conjunction with -i to select the 1st IPv6 address on the interface.
72 .It Fl 4
73 Used in conjunction with -i to select the 1st IPv4 address on the interface.
74 This is the default and assumed if -6 or -4 is not supplied.
75 .El
76 .Sh SEE ALSO
77 .Xr gethostname 3 ,
78 .Xr rc.conf 5
79 .Sh HISTORY
80 The
81 .Nm
82 command appeared in
83 .Bx 4.2 .