uuids.5: Fix error and improve wording
[dragonfly.git] / share / man / man5 / uuids.5
CommitLineData
c907da5c
TN
1.\"
2.\" Copyright (c) 2008
3.\" The DragonFly Project. All rights reserved.
4.\"
5.\" Redistribution and use in source and binary forms, with or without
6.\" modification, are permitted provided that the following conditions
7.\" are met:
8.\"
9.\" 1. Redistributions of source code must retain the above copyright
10.\" notice, this list of conditions and the following disclaimer.
11.\" 2. Redistributions in binary form must reproduce the above copyright
12.\" notice, this list of conditions and the following disclaimer in
13.\" the documentation and/or other materials provided with the
14.\" distribution.
15.\" 3. Neither the name of The DragonFly Project nor the names of its
16.\" contributors may be used to endorse or promote products derived
17.\" from this software without specific, prior written permission.
18.\"
19.\" THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
20.\" ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
21.\" LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
22.\" FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
23.\" COPYRIGHT HOLDERS OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
24.\" INCIDENTAL, SPECIAL, EXEMPLARY OR CONSEQUENTIAL DAMAGES (INCLUDING,
25.\" BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
26.\" LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
27.\" AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
28.\" OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
29.\" OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
30.\" SUCH DAMAGE.
31.\"
7b2f1967 32.\" $DragonFly: src/share/man/man5/uuids.5,v 1.2 2008/07/28 12:38:36 swildner Exp $
c907da5c 33.\"
a721927b 34.Dd February 8, 2009
c907da5c
TN
35.Os
36.Dt UUIDS 5
37.Sh NAME
38.Nm uuids
39.Nd UUIDs and their symbolic names
40.Sh SYNOPSIS
41.Nm /etc/defaults/uuids
42.Nm /etc/uuids
43.Sh DESCRIPTION
44A
45.Nm
a721927b 46file contains a list of UUIDs (universally unique identifiers) and their symbolic names.
c907da5c
TN
47.Pp
48Each line in a
49.Nm
50file, other than comment lines that begin with a
51.Sq # ,
a721927b 52specifies a UUID and its symbolic name.
c907da5c
TN
53The first field is the UUID, the second field is the name,
54they are separated by tabs or spaces.
a721927b 55A UUID is a 128 bit number written in hexadecimal and formatted like this:
c907da5c 5601234567-89ab-cdef-0123-456789abcdef,
a721927b
TN
57i.e. 16 hexadecimal digits, with dash
58.Pq Sq - ,
c907da5c 59after digit no. 8, 12, 16 and 20.
a721927b
TN
60A name is a text string enclosed in double quotes
61.Pq Sq \&" .
c907da5c 62.Sh EXAMPLES
a721927b 63A UUID with name
c907da5c 64.Dq test UUID :
c907da5c
TN
65.Bd -literal -offset indent
66# test uuids(5) file
67061ceb5d-5beb-11dd-924c-010e0cd0bad1 "test UUID"
68.Ed
69.Sh FILES
70.Bl -tag -width ".Pa /etc/defaults/uuids" -compact
71.It Pa /etc/defaults/uuids
72A list of UUIDs and their symbolic names provided by the OS vendor.
73.It Pa /etc/uuids
74A list of UUIDs and their symbolic names provided by the
75system administrator.
76.El
77.Sh SEE ALSO
78.Xr uuid 3
79.Sh AUTHORS
80This manual page was written by
81.An Thomas Nikolajsen .