Merge branch 'vendor/GREP'
[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. 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 .\"     @(#)hostname.1  8.2 (Berkeley) 4/28/95
29 .\" $FreeBSD: src/bin/hostname/hostname.1,v 1.10.2.4 2002/04/22 22:20:29 keramida Exp $
30 .\" $DragonFly: src/bin/hostname/hostname.1,v 1.5 2007/12/16 02:55:37 thomas Exp $
31 .\"
32 .Dd April 28, 1995
33 .Dt HOSTNAME 1
34 .Os
35 .Sh NAME
36 .Nm hostname
37 .Nd set or print name of current host system
38 .Sh SYNOPSIS
39 .Nm
40 .Op Fl s
41 .Op Ar name-of-host | Fl r Ar ip-address | Fl i Ar interface Op Fl 6 | Fl 4
42 .Sh DESCRIPTION
43 The
44 .Nm
45 utility prints the name of the current host.
46 The super-user can set the hostname by supplying an argument;
47 this is usually done at boot time by setting the
48 .Va hostname
49 variable in
50 .Pa /etc/rc.conf .
51 .Pp
52 Options:
53 .Bl -tag -width flag
54 .It Fl s
55 Trim off any domain information from the printed
56 name.
57 .It Fl r
58 Retrieve hostname via ip lookup.
59 The hostname is set to the first (official)
60 name returned for the supplied ip address.
61 Can be an IPv6 or IPv4 address.
62 .It Fl i
63 Retrieve hostname via supplied interface name.
64 .It Fl 6
65 Used in conjunction with
66 .Fl i
67 to select the 1st IPv6 address on the interface.
68 .It Fl 4
69 Used in conjunction with
70 .Fl i
71 to select the 1st IPv4 address on the interface.
72 This is the default and assumed if
73 .Fl 6
74 or
75 .Fl 4
76 is not supplied.
77 .El
78 .Sh SEE ALSO
79 .Xr gethostname 3 ,
80 .Xr rc.conf 5
81 .Sh HISTORY
82 The
83 .Nm
84 command appeared in
85 .Bx 4.2 .