]>
Commit | Line | Data |
---|---|---|
3f2457aa A |
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 | .\" $FreeBSD: src/lib/libutil/trimdomain.3,v 1.8 2004/07/02 23:52:20 ru Exp $ | |
26 | .\" | |
27 | .Dd April 7, 1999 | |
28 | .Os | |
29 | .Dt TRIMDOMAIN 3 | |
30 | .Sh NAME | |
31 | .Nm trimdomain | |
32 | .Nd "trim the current domain name from a host name" | |
33 | .Sh LIBRARY | |
34 | .Lb libutil | |
35 | .Sh SYNOPSIS | |
36 | .In sys/types.h | |
37 | .In libutil.h | |
38 | .Ft void | |
39 | .Fn trimdomain "char *fullhost" "int hostsize" | |
40 | .Sh DESCRIPTION | |
41 | The function | |
42 | .Fn trimdomain | |
43 | removes the current domain name from the passed | |
44 | .Ar fullhost | |
45 | name by writing a | |
46 | .Dv NUL | |
47 | character over the first period of the passed name. | |
48 | The current domain | |
49 | name is determined by calling | |
50 | .Xr gethostname 3 | |
51 | and removing everything up to the first period. | |
52 | The name is determined | |
53 | the first time this function is called and is cached for future use. | |
54 | .Pp | |
55 | The | |
56 | .Fn trimdomain | |
57 | function will only trim the domain name if the passed | |
58 | .Ar fullname | |
59 | ends with the current domain name and if the length of the resulting host | |
60 | name does not exceed | |
61 | .Ar hostsize . | |
62 | .Pp | |
63 | If the passed | |
64 | .Ar fullname | |
65 | is actually a | |
66 | .Dv DISPLAY | |
67 | specification of the form | |
68 | .Sm off | |
69 | .Ar host . domain : nn Oo . | |
70 | .Ar nn | |
71 | .Oc | |
72 | .Sm on | |
73 | and the domain name is the same as the local domain name, | |
74 | .Fn trimdomain | |
75 | will remove the embedded domain name, copying the screen and display | |
76 | numbers to the end of the base host name and resulting in | |
77 | .Sm off | |
78 | .Ar host : nn Op . Ar nn . | |
79 | .Sm on | |
80 | .Sh RETURN VALUES | |
81 | The | |
82 | .Fn trimdomain | |
83 | function does not return a value. | |
84 | .Sh SEE ALSO | |
85 | .Xr gethostname 3 |