freebsd-skq/lib/libutil/trimdomain.3

.\" Copyright (c) 1999 Brian Somers <brian@Awfulhak.org>
.\" 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.
.\"
.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR 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 AUTHOR 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.
.\"
.\" $FreeBSD$
.\"
.Dd April 7, 1999
.Dt TRIMDOMAIN 3
.Os
.Sh NAME
.Nm trimdomain
.Nd "trim the current domain name from a host name"
.Sh LIBRARY
.Lb libutil
.Sh SYNOPSIS
.In sys/types.h
.In libutil.h
.Ft void
.Fn trimdomain "char *fullhost" "int hostsize"
.Sh DESCRIPTION
The function
.Fn trimdomain
removes the current domain name from the passed
.Ar fullhost
name by writing a
.Dv NUL
character over the first period of the passed name.
The current domain
name is determined by calling
.Xr gethostname 3
and removing everything up to the first period.
The name is determined
the first time this function is called and is cached for future use.
.Pp
The
.Fn trimdomain
function will only trim the domain name if the passed
.Ar fullname
ends with the current domain name and if the length of the resulting host
name does not exceed
.Ar hostsize .
.Pp
If the passed
.Ar fullname
is actually a
.Dv DISPLAY
specification of the form
.Sm off
.Ar host . domain : nn Oo .
.Ar nn
.Oc
.Sm on
and the domain name is the same as the local domain name,
.Fn trimdomain
will remove the embedded domain name, copying the screen and display
numbers to the end of the base host name and resulting in
.Sm off
.Ar host : nn Op . Ar nn .
.Sm on
.Sh RETURN VALUES
The
.Fn trimdomain
function does not return a value.
.Sh SEE ALSO
.Xr gethostname 3
.Sh HISTORY
The function
.Fn trimdomain
first appeared in
.Fx 3.2 .
Tidy up trimdomain() and document it. Don't truncate one byte short of the passed length. 1999-04-07 14:03:31 +00:00			`.\" Copyright (c) 1999 Brian Somers <brian@Awfulhak.org>`
			`.\" 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.`
			`.\"`
			.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR 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 AUTHOR 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.`
			`.\"`
$Id$ -> $FreeBSD$ 1999-08-28 00:22:10 +00:00			`.\" $FreeBSD$`
Tidy up trimdomain() and document it. Don't truncate one byte short of the passed length. 1999-04-07 14:03:31 +00:00			`.\"`
			`.Dd April 7, 1999`
			`.Dt TRIMDOMAIN 3`
mdoc: order prologue macros consistently by Dd/Dt/Os Although groff_mdoc(7) gives another impression, this is the ordering most widely used and also required by mdocml/mandoc. Reviewed by: ru Approved by: philip, ed (mentors) 2010-04-14 19:08:06 +00:00			`.Os`
Tidy up trimdomain() and document it. Don't truncate one byte short of the passed length. 1999-04-07 14:03:31 +00:00			`.Sh NAME`
			`.Nm trimdomain`
			`.Nd "trim the current domain name from a host name"`
Introduce .Lb macro to libutil manpages Sort .Nm values in some manpages Remove explicit note about compiling with -lutil, it's implicitly declared by .Lb macro now. 2000-04-22 16:17:00 +00:00			`.Sh LIBRARY`
			`.Lb libutil`
Tidy up trimdomain() and document it. Don't truncate one byte short of the passed length. 1999-04-07 14:03:31 +00:00			`.Sh SYNOPSIS`
mdoc(7) police: Use the new .In macro for #include statements. 2001-10-01 16:09:29 +00:00			`.In sys/types.h`
			`.In libutil.h`
Tidy up trimdomain() and document it. Don't truncate one byte short of the passed length. 1999-04-07 14:03:31 +00:00			`.Ft void`
			`.Fn trimdomain "char *fullhost" "int hostsize"`
			`.Sh DESCRIPTION`
			`The function`
			`.Fn trimdomain`
			`removes the current domain name from the passed`
			`.Ar fullhost`
			`name by writing a`
			`.Dv NUL`
Mechanically kill hard sentence breaks. 2004-07-02 23:52:20 +00:00			`character over the first period of the passed name.`
			`The current domain`
Tidy up trimdomain() and document it. Don't truncate one byte short of the passed length. 1999-04-07 14:03:31 +00:00			`name is determined by calling`
			`.Xr gethostname 3`
Mechanically kill hard sentence breaks. 2004-07-02 23:52:20 +00:00			`and removing everything up to the first period.`
			`The name is determined`
Tidy up trimdomain() and document it. Don't truncate one byte short of the passed length. 1999-04-07 14:03:31 +00:00			`the first time this function is called and is cached for future use.`
			`.Pp`
The .Fn function 2003-03-24 16:02:05 +00:00			`The`
Tidy up trimdomain() and document it. Don't truncate one byte short of the passed length. 1999-04-07 14:03:31 +00:00			`.Fn trimdomain`
The .Fn function 2003-03-24 16:02:05 +00:00			`function will only trim the domain name if the passed`
Tidy up trimdomain() and document it. Don't truncate one byte short of the passed length. 1999-04-07 14:03:31 +00:00			`.Ar fullname`
			`ends with the current domain name and if the length of the resulting host`
			`name does not exceed`
			`.Ar hostsize .`
If given host.domain:nn[.nn], trimdomain() now reduces it to host:nn[.nn] (if the domain is the same as the local one). 1999-04-09 01:54:10 +00:00			`.Pp`
			`If the passed`
			`.Ar fullname`
			`is actually a`
			`.Dv DISPLAY`
			`specification of the form`
			`.Sm off`
Prepare for mdoc(7)NG. 2000-12-29 14:08:20 +00:00			`.Ar host . domain : nn Oo .`
			`.Ar nn`
If given host.domain:nn[.nn], trimdomain() now reduces it to host:nn[.nn] (if the domain is the same as the local one). 1999-04-09 01:54:10 +00:00			`.Oc`
Prepare for mdoc(7)NG. 2000-12-29 14:08:20 +00:00			`.Sm on`
If given host.domain:nn[.nn], trimdomain() now reduces it to host:nn[.nn] (if the domain is the same as the local one). 1999-04-09 01:54:10 +00:00			`and the domain name is the same as the local domain name,`
			`.Fn trimdomain`
			`will remove the embedded domain name, copying the screen and display`
			`numbers to the end of the base host name and resulting in`
Prepare for mdoc(7)NG. 2000-12-29 14:08:20 +00:00			`.Sm off`
			`.Ar host : nn Op . Ar nn .`
			`.Sm on`
Tidy up trimdomain() and document it. Don't truncate one byte short of the passed length. 1999-04-07 14:03:31 +00:00			`.Sh RETURN VALUES`
The .Fn function 2003-03-24 16:02:05 +00:00			`The`
Tidy up trimdomain() and document it. Don't truncate one byte short of the passed length. 1999-04-07 14:03:31 +00:00			`.Fn trimdomain`
The .Fn function 2003-03-24 16:02:05 +00:00			`function does not return a value.`
Tidy up trimdomain() and document it. Don't truncate one byte short of the passed length. 1999-04-07 14:03:31 +00:00			`.Sh SEE ALSO`
			`.Xr gethostname 3`
libutil: Document function HISTORY within the manpages Reviewed by: bcr (mentor) Approved by: bcr (mentor) MFC after: 7 days Differential Revision: https://reviews.freebsd.org/D24795 2020-06-14 05:35:02 +00:00			`.Sh HISTORY`
			`The function`
			`.Fn trimdomain`
			`first appeared in`
			`.Fx 3.2 .`