xref: /freebsd/lib/libutil/trimdomain.3 (revision f5463265955b829775bbb32e1fd0bc11dafc36ce)
1.\" Copyright (c) 1999 Brian Somers <brian@Awfulhak.org>
2.\" 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.\"
13.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
14.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
15.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
16.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
17.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
18.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
19.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
20.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
21.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
22.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
23.\" SUCH DAMAGE.
24.\"
25.Dd April 7, 1999
26.Dt TRIMDOMAIN 3
27.Os
28.Sh NAME
29.Nm trimdomain
30.Nd "trim the current domain name from a host name"
31.Sh LIBRARY
32.Lb libutil
33.Sh SYNOPSIS
34.In sys/types.h
35.In libutil.h
36.Ft void
37.Fn trimdomain "char *fullhost" "int hostsize"
38.Sh DESCRIPTION
39The function
40.Fn trimdomain
41removes the current domain name from the passed
42.Ar fullhost
43name by writing a
44.Dv NUL
45character over the first period of the passed name.
46The current domain
47name is determined by calling
48.Xr gethostname 3
49and removing everything up to the first period.
50The name is determined
51the first time this function is called and is cached for future use.
52.Pp
53The
54.Fn trimdomain
55function will only trim the domain name if the passed
56.Ar fullname
57ends with the current domain name and if the length of the resulting host
58name does not exceed
59.Ar hostsize .
60.Pp
61If the passed
62.Ar fullname
63is actually a
64.Dv DISPLAY
65specification of the form
66.Sm off
67.Ar host . domain : nn Oo .
68.Ar nn
69.Oc
70.Sm on
71and the domain name is the same as the local domain name,
72.Fn trimdomain
73will remove the embedded domain name, copying the screen and display
74numbers to the end of the base host name and resulting in
75.Sm off
76.Ar host : nn Op . Ar nn .
77.Sm on
78.Sh RETURN VALUES
79The
80.Fn trimdomain
81function does not return a value.
82.Sh SEE ALSO
83.Xr gethostname 3
84.Sh HISTORY
85The function
86.Fn trimdomain
87first appeared in
88.Fx 3.2 .
89