freebsd-skq/bin/hostname/hostname.1

.\"-
.\" Copyright (c) 1983, 1988, 1990, 1993
.\"	The Regents of the University of California.  All rights reserved.
.\"
.\" Redistribution and use in source and binary forms, with or without
.\" modification, are permitted provided that the following conditions
.\" are met:
.\" 1. Redistributions of source code must retain the above copyright
.\"    notice, this list of conditions and the following disclaimer.
.\" 2. Redistributions in binary form must reproduce the above copyright
.\"    notice, this list of conditions and the following disclaimer in the
.\"    documentation and/or other materials provided with the distribution.
.\" 3. Neither the name of the University nor the names of its contributors
.\"    may be used to endorse or promote products derived from this software
.\"    without specific prior written permission.
.\"
.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
.\" SUCH DAMAGE.
.\"
.\"	@(#)hostname.1	8.2 (Berkeley) 4/28/95
.\" $FreeBSD$
.\"
.Dd October 5, 2020
.Dt HOSTNAME 1
.Os
.Sh NAME
.Nm hostname
.Nd set or print name of current host system
.Sh SYNOPSIS
.Nm
.Op Fl f
.Op Fl s | d
.Op Ar name-of-host
.Sh DESCRIPTION
The
.Nm
utility prints the name of the current host.
The super-user can
set the hostname by supplying an argument; this is usually done in the
initialization script
.Pa /etc/rc.d/hostname ,
normally run at boot
time.
This script uses the
.Va hostname
variable in
.Pa /etc/rc.conf .
.Pp
Options:
.Bl -tag -width flag
.It Fl f
Include domain information in the printed name.
This is the default behavior.
.It Fl s
Trim off any domain information from the printed
name.
.It Fl d
Only print domain information.
.El
.Sh EXAMPLES
Set the host name of the machine and check the result:
.Bd -literal -offset indent
$ hostname beastie.localdomain.org
$ hostname
beastie.localdomain.org
.Ed
.Pp
Do not show domain information:
.Bd -literal -offset indent
$ hostname -s
beastie
.Ed
.Pp
Show only domain information:
.Bd -literal -offset indent
$ hostname -d
localdomain.org
.Ed
.Sh SEE ALSO
.Xr gethostname 3 ,
.Xr rc.conf 5
.Sh HISTORY
The
.Nm
command appeared in
.Bx 4.2 .
/*- or .\"- or #- to begin license clauses. 2005-01-10 08:39:26 +00:00			`.\"-`
BSD 4.4 Lite bin Sources 1994-05-26 06:18:55 +00:00			`.\" Copyright (c) 1983, 1988, 1990, 1993`
			`.\" The Regents of the University of California. All rights reserved.`
			`.\"`
			`.\" Redistribution and use in source and binary forms, with or without`
			`.\" modification, are permitted provided that the following conditions`
			`.\" are met:`
			`.\" 1. Redistributions of source code must retain the above copyright`
			`.\" notice, this list of conditions and the following disclaimer.`
			`.\" 2. Redistributions in binary form must reproduce the above copyright`
			`.\" notice, this list of conditions and the following disclaimer in the`
			`.\" documentation and/or other materials provided with the distribution.`
Renumber copyright clause 4 Renumber cluase 4 to 3, per what everybody else did when BSD granted them permission to remove clause 3. My insistance on keeping the same numbering for legal reasons is too pedantic, so give up on that point. Submitted by: Jan Schaumann <jschauma@stevens.edu> Pull Request: https://github.com/freebsd/freebsd/pull/96 2017-02-28 23:42:47 +00:00			`.\" 3. Neither the name of the University nor the names of its contributors`
BSD 4.4 Lite bin Sources 1994-05-26 06:18:55 +00:00			`.\" may be used to endorse or promote products derived from this software`
			`.\" without specific prior written permission.`
			`.\"`
			.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
			`.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE`
			`.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE`
			`.\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE`
			`.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL`
			`.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS`
			`.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)`
			`.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT`
			`.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY`
			`.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF`
			`.\" SUCH DAMAGE.`
			`.\"`
Merge Lite2 mods, -Wall cleaning, and show usage if incorrectly called. Incorrect usage mod obtained from: NetBSD 1996-12-14 05:59:58 +00:00			`.\" @(#)hostname.1 8.2 (Berkeley) 4/28/95`
$Id$ -> $FreeBSD$ 1999-08-27 23:15:48 +00:00			`.\" $FreeBSD$`
BSD 4.4 Lite bin Sources 1994-05-26 06:18:55 +00:00			`.\"`
hostname(1): Add EXAMPLES to man page Add a very simple set of examples Approved by: manpages (bcr@) Differential Revision: https://reviews.freebsd.org/D26663 2020-10-05 13:46:19 +00:00			`.Dd October 5, 2020`
BSD 4.4 Lite bin Sources 1994-05-26 06:18:55 +00:00			`.Dt HOSTNAME 1`
mdoc(7) police: removed HISTORY info from the .Os call. 2001-07-10 10:04:09 +00:00			`.Os`
BSD 4.4 Lite bin Sources 1994-05-26 06:18:55 +00:00			`.Sh NAME`
			`.Nm hostname`
			`.Nd set or print name of current host system`
			`.Sh SYNOPSIS`
mdoc(7) police: use the new features of the Nm macro. 2000-11-20 11:39:41 +00:00			`.Nm`
Add -d flag that prints domain only. PR: 212875 Submitted by: Ben RUBSON <ben.rubson@gmail.com> Reviewed by: pi 2016-11-08 11:36:33 +00:00			`.Op Fl f`
Fix missing '-' for the flags -s and -d on both manpage and usage. Reported by: garga, bde 2016-11-09 04:42:09 +00:00			`.Op Fl s \| d`
Merge Lite2 mods, -Wall cleaning, and show usage if incorrectly called. Incorrect usage mod obtained from: NetBSD 1996-12-14 05:59:58 +00:00			`.Op Ar name-of-host`
BSD 4.4 Lite bin Sources 1994-05-26 06:18:55 +00:00			`.Sh DESCRIPTION`
Use `The .Nm utility' 2002-04-16 20:08:06 +00:00			`The`
			`.Nm`
Mechanically kill hard sentence breaks. 2004-07-02 21:04:19 +00:00			`utility prints the name of the current host.`
			`The super-user can`
BSD 4.4 Lite bin Sources 1994-05-26 06:18:55 +00:00			`set the hostname by supplying an argument; this is usually done in the`
Once upon a time, the hostname was being set in the /etc/netstart, which can be called a "network initialization script", now that it is set in /etc/rc.d/hostname, "network" sounds confusing, so remove it. 2006-12-05 12:09:50 +00:00			`initialization script`
There is no /etc/rc.network anymore. Submitted by: Benjamin Rossen <b.rossen@onsnet.nu> MFC after: 2 weeks 2005-04-17 23:22:22 +00:00			`.Pa /etc/rc.d/hostname ,`
BSD 4.4 Lite bin Sources 1994-05-26 06:18:55 +00:00			`normally run at boot`
			`time.`
Mention the hostname variable in /etc/rc.conf since that is the most common way of setting the hostname. The man page already mentioned that the hostname is set by /etc/rc.network, so this just explains where /etc/rc.network gets the hostname from. PR: docs/14319 Submitted by: rwatson Reviewed by: cmc 1999-12-22 01:28:49 +00:00			`This script uses the`
			`.Va hostname`
			`variable in`
			`.Pa /etc/rc.conf .`
BSD 4.4 Lite bin Sources 1994-05-26 06:18:55 +00:00			`.Pp`
			`Options:`
			`.Bl -tag -width flag`
Support the "-f" option by simply ignoring it. This allows script compatibility with Linux, whose "hostname" is the same as BSD "hostname -s". With this change, "hostname -f" is the same on both systems. MFC after: 7 days 2006-12-08 07:19:51 +00:00			`.It Fl f`
			`Include domain information in the printed name.`
			`This is the default behavior.`
BSD 4.4 Lite bin Sources 1994-05-26 06:18:55 +00:00			`.It Fl s`
Correct use of .Nm. Add rcsid. 1998-05-13 07:47:35 +00:00			`Trim off any domain information from the printed`
BSD 4.4 Lite bin Sources 1994-05-26 06:18:55 +00:00			`name.`
Add -d flag that prints domain only. PR: 212875 Submitted by: Ben RUBSON <ben.rubson@gmail.com> Reviewed by: pi 2016-11-08 11:36:33 +00:00			`.It Fl d`
			`Only print domain information.`
BSD 4.4 Lite bin Sources 1994-05-26 06:18:55 +00:00			`.El`
hostname(1): Add EXAMPLES to man page Add a very simple set of examples Approved by: manpages (bcr@) Differential Revision: https://reviews.freebsd.org/D26663 2020-10-05 13:46:19 +00:00			`.Sh EXAMPLES`
			`Set the host name of the machine and check the result:`
			`.Bd -literal -offset indent`
			`$ hostname beastie.localdomain.org`
			`$ hostname`
			`beastie.localdomain.org`
			`.Ed`
			`.Pp`
			`Do not show domain information:`
			`.Bd -literal -offset indent`
			`$ hostname -s`
			`beastie`
			`.Ed`
			`.Pp`
			`Show only domain information:`
			`.Bd -literal -offset indent`
			`$ hostname -d`
			`localdomain.org`
			`.Ed`
BSD 4.4 Lite bin Sources 1994-05-26 06:18:55 +00:00			`.Sh SEE ALSO`
Remove whitespace at EOL. 2001-07-15 07:53:42 +00:00			`.Xr gethostname 3 ,`
Mention the hostname variable in /etc/rc.conf since that is the most common way of setting the hostname. The man page already mentioned that the hostname is set by /etc/rc.network, so this just explains where /etc/rc.network gets the hostname from. PR: docs/14319 Submitted by: rwatson Reviewed by: cmc 1999-12-22 01:28:49 +00:00			`.Xr rc.conf 5`
BSD 4.4 Lite bin Sources 1994-05-26 06:18:55 +00:00			`.Sh HISTORY`
			`The`
Correct use of .Nm. Add rcsid. 1998-05-13 07:47:35 +00:00			`.Nm`
BSD 4.4 Lite bin Sources 1994-05-26 06:18:55 +00:00			`command appeared in`
			`.Bx 4.2 .`