11223
|
1 |
<!DOCTYPE REFENTRY PUBLIC "-//Sun Microsystems//DTD DocBook V3.0-Based SolBook Subset V2.0//EN" [
|
|
2 |
<!--ArborText, Inc., 1988-1999, v.4002-->
|
|
3 |
<!ENTITY cmd "dbus-uuidgen">
|
|
4 |
<!ENTITY % commonents SYSTEM "smancommon.ent">
|
|
5 |
%commonents;
|
|
6 |
<!ENTITY % booktitles SYSTEM "booktitles.ent">
|
|
7 |
%booktitles;
|
|
8 |
<!ENTITY suncopy "Copyright (c) 2007 Sun Microsystems, Inc. All Rights Reserved.">
|
|
9 |
]>
|
|
10 |
<?Pub UDT _bookmark _target>
|
|
11 |
<?Pub Inc>
|
|
12 |
<refentry id="dbus-uuidgen-1">
|
|
13 |
<!-- %Z%%M% %I% %E% SMI; -->
|
|
14 |
<refmeta><refentrytitle>dbus-uuidgen</refentrytitle><manvolnum>1</manvolnum>
|
|
15 |
<refmiscinfo class="date">19 Nov 2007</refmiscinfo>
|
|
16 |
<refmiscinfo class="sectdesc">&man1;</refmiscinfo>
|
|
17 |
<refmiscinfo class="software">&release;</refmiscinfo>
|
|
18 |
<refmiscinfo class="arch">generic</refmiscinfo>
|
|
19 |
<refmiscinfo class="copyright">&suncopy;</refmiscinfo>
|
|
20 |
</refmeta>
|
|
21 |
<indexterm><primary>dbus-uuidgen</primary></indexterm><indexterm><primary>
|
|
22 |
Utility to generate UUIDs
|
|
23 |
</primary></indexterm><refnamediv id="dbus-uuidgen-1-name">
|
|
24 |
<refname>dbus-uuidgen</refname><refpurpose>
|
|
25 |
Utility to generate UUIDs
|
|
26 |
</refpurpose></refnamediv>
|
|
27 |
<refsynopsisdiv id="dbus-uuidgen-1-synp"><title>&synp-tt;</title>
|
|
28 |
<cmdsynopsis><command>&cmd;</command>
|
|
29 |
<arg choice="opt"><option>-ensure=<replaceable>file</replaceable></option></arg>
|
|
30 |
<arg choice="opt"><option>-get=<replaceable>file</replaceable></option></arg>
|
|
31 |
<arg choice="opt"><option>-version</option></arg>
|
|
32 |
</cmdsynopsis></refsynopsisdiv>
|
|
33 |
<refsect1 id="dbus-uuidgen-1-desc"><title>&desc-tt;</title>
|
|
34 |
<para>
|
|
35 |
The &cmd; command generates or reads a universally unique ID.
|
|
36 |
</para>
|
|
37 |
<para>
|
|
38 |
Note that the D\-Bus UUID has no relationship to RFC 4122 and does not generate
|
|
39 |
UUIDs compatible with that spec. Many systems have a separate command for that
|
|
40 |
(often called "uuidgen").
|
|
41 |
</para>
|
|
42 |
<para>
|
|
43 |
The primary usage of &cmd; is to run in the post-install script of a D\-Bus
|
|
44 |
package as shown in the example section of this document.
|
|
45 |
</para>
|
|
46 |
<para>
|
|
47 |
This will ensure that <filename>/var/lib/dbus/machine-id</filename> exists and
|
|
48 |
has the uuid in it. It will not overwrite an existing uuid, since this id
|
|
49 |
should remain fixed for a single machine until the next reboot at least.
|
|
50 |
</para>
|
|
51 |
<para>
|
|
52 |
The important properties of the machine UUID are that 1) it remains unchanged
|
|
53 |
until the next reboot and 2) it is different for any two running instances of
|
|
54 |
the OS kernel. That is, if two processes see the same UUID, they should also
|
|
55 |
see the same shared memory, UNIX domain sockets, local X displays,
|
|
56 |
localhost.localdomain resolution, process IDs, and so forth.
|
|
57 |
</para>
|
|
58 |
<para>
|
|
59 |
If you run &cmd; with no options it just prints a new uuid made up out of thin
|
|
60 |
air.
|
|
61 |
</para>
|
|
62 |
<para>
|
|
63 |
If you run &cmd; with <option>-get</option>, it prints the machine UUID by
|
|
64 |
default, or the UUID in the specified file if you specify a file.
|
|
65 |
</para>
|
|
66 |
<para>
|
|
67 |
If you try to change an existing machine-id on a running system, it will
|
|
68 |
probably result in bad things happening. Do not try to change this file.
|
|
69 |
Also, do not make it the same on two different systems; it needs to be
|
|
70 |
different anytime there are two different kernels running.
|
|
71 |
</para>
|
|
72 |
<para>
|
|
73 |
The UUID should be different on two different virtual machines, because there
|
|
74 |
are two different kernels.
|
|
75 |
</para>
|
|
76 |
<para>
|
|
77 |
See <literal>http://www.freedesktop.org/software/dbus/</literal>
|
|
78 |
for more information.
|
|
79 |
</para>
|
|
80 |
</refsect1>
|
|
81 |
<refsect1 id="dbus-uuidgen-1-opts"><title>&opts-tt;</title>
|
|
82 |
<para>The following options are supported:</para>
|
|
83 |
<variablelist termlength="wholeline">
|
|
84 |
<varlistentry>
|
|
85 |
<term><option>-ensure=<replaceable>file</replaceable></option></term>
|
|
86 |
<listitem><para>
|
|
87 |
If a <replaceable>file</replaceable> is not given, defaults to
|
|
88 |
<filename>/var/lib/dbus/machine-id</filename>. If this
|
|
89 |
<replaceable>file</replaceable> exists then it will be validated, and a failure
|
|
90 |
code returned if it contains the wrong thing. If the file does not exist, it
|
|
91 |
will be created with a new uuid in it. On success, prints no output.
|
|
92 |
</para>
|
|
93 |
</listitem></varlistentry>
|
|
94 |
<varlistentry>
|
|
95 |
<term><option>-get=<replaceable>file</replaceable></option></term>
|
|
96 |
<listitem><para>
|
|
97 |
If a file is not given, defaults to
|
|
98 |
<filename>/var/lib/dbus/machine-id</filename>. If this
|
|
99 |
<replaceable>file</replaceable> exists and is valid, the uuid in the file is
|
|
100 |
printed on <literal>stdout</literal>. Otherwise, the command exits with a
|
|
101 |
nonzero status.
|
|
102 |
</para>
|
|
103 |
</listitem></varlistentry>
|
|
104 |
<varlistentry>
|
|
105 |
<term><option>-version</option></term>
|
|
106 |
<listitem><para>
|
|
107 |
Print the version of &cmd;
|
|
108 |
</para>
|
|
109 |
</listitem></varlistentry>
|
|
110 |
</variablelist></refsect1>
|
|
111 |
<refsect1 id="dbus-uuidgen-1-exam"><title>&exam-tt;</title>
|
|
112 |
<example role="example">
|
|
113 |
<title>The primary usage of &cmd; is to run in the post-install script of a
|
|
114 |
D\-Bus package</title>
|
|
115 |
</para>
|
|
116 |
<para><screen>
|
|
117 |
dbus-uuidgen --ensure</userinput>
|
|
118 |
</screen></para>
|
|
119 |
</example>
|
|
120 |
</refsect1>
|
|
121 |
<refsect1 id="dbus-uuidgen-1-exit"><title>&exit-tt;</title>
|
|
122 |
<para>The following exit values are returned:</para>
|
|
123 |
<variablelist termlength="xtranarrow">
|
|
124 |
<varlistentry>
|
|
125 |
<term><returnvalue>0</returnvalue></term>
|
|
126 |
<listitem><para>
|
|
127 |
Application exited successfully
|
|
128 |
</para>
|
|
129 |
</listitem></varlistentry>
|
|
130 |
<varlistentry>
|
|
131 |
<term><returnvalue>>0</returnvalue></term>
|
|
132 |
<listitem><para>
|
|
133 |
Application exited with failure
|
|
134 |
</para>
|
|
135 |
</listitem></varlistentry>
|
|
136 |
</variablelist></refsect1>
|
|
137 |
<refsect1 id="dbus-uuidgen-1-file"><title>&file-tt;</title>
|
|
138 |
<para>The following files are used by this application:</para>
|
|
139 |
<variablelist termlength="wide">
|
|
140 |
<varlistentry>
|
|
141 |
<term><filename>/usr/bin/&cmd;</filename></term>
|
|
142 |
<listitem><para>
|
|
143 |
Executable for &cmd;
|
|
144 |
</para>
|
|
145 |
</listitem></varlistentry>
|
|
146 |
<variablelist termlength="wide">
|
|
147 |
<varlistentry>
|
|
148 |
<term><filename>/var/lib/dbus/machine-id</filename></term>
|
|
149 |
<listitem><para>
|
|
150 |
File containing the uuid generated for this machine.
|
|
151 |
</para>
|
|
152 |
</listitem></varlistentry>
|
|
153 |
</variablelist></refsect1>
|
|
154 |
<refsect1 id="dbus-uuidgen-1-attr"><title>&attr-tt;</title>
|
|
155 |
<para>See <olink targetdocent="REFMAN5" localinfo="attributes-5"><citerefentry>
|
|
156 |
<refentrytitle>attributes</refentrytitle><manvolnum>5</manvolnum></citerefentry></olink>
|
|
157 |
for descriptions of the following attributes:</para>
|
|
158 |
<informaltable frame="all">
|
|
159 |
<tgroup cols="2" colsep="1" rowsep="1"><colspec colname="COLSPEC0" colwidth="1*">
|
|
160 |
<colspec colname="COLSPEC1" colwidth="1*">
|
|
161 |
<thead>
|
|
162 |
<row><entry align="center" valign="middle">ATTRIBUTE TYPE</entry><entry align="center"
|
|
163 |
valign="middle">ATTRIBUTE VALUE</entry></row>
|
|
164 |
</thead>
|
|
165 |
<tbody>
|
|
166 |
<row><entry>
|
|
167 |
<para>Availability</para>
|
|
168 |
</entry><entry>
|
|
169 |
<para>SUNWdbus</para>
|
|
170 |
</entry></row><row><entry colname="COLSPEC0">
|
|
171 |
<para>Interface stability</para>
|
|
172 |
</entry><entry colname="COLSPEC1">
|
|
173 |
<para>Volatile</para>
|
|
174 |
</entry></row>
|
|
175 |
</tbody>
|
|
176 |
</tgroup>
|
|
177 |
</informaltable>
|
|
178 |
</refsect1>
|
|
179 |
<refsect1 id="dbus-uuidgen-1-also"><title>&also-tt;</title>
|
|
180 |
<!--Reference to another man page-->
|
|
181 |
<!--Reference to a Help manual-->
|
|
182 |
<!--Reference to a book.-->
|
|
183 |
<para>
|
|
184 |
<citerefentry><refentrytitle>dbus-cleanup-sockets</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
|
13189
|
185 |
<citerefentry><refentrytitle>dbus-daemon</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
|
11223
|
186 |
<citerefentry><refentrytitle>dbus-launch</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
|
|
187 |
<citerefentry><refentrytitle>dbus-monitor</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
|
|
188 |
<citerefentry><refentrytitle>dbus-send</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
|
|
189 |
<citerefentry><refentrytitle>libdbus-glib-1</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
|
|
190 |
<citerefentry><refentrytitle>attributes</refentrytitle><manvolnum>5</manvolnum></citerefentry>
|
|
191 |
</para>
|
|
192 |
</refsect1>
|
|
193 |
<refsect1 id="dbus-uuidgen-1-note"><title>¬e-tt;</title>
|
|
194 |
<para>
|
|
195 |
For authorship information refer to
|
|
196 |
<literal>http://www.freedesktop.org/software/dbus/doc/AUTHORS</literal>.
|
|
197 |
Updated by Brian Cameron, Sun Microsystems Inc., 2007.
|
|
198 |
</para>
|
|
199 |
<para>
|
|
200 |
Please send bug reports to the D\-Bus mailing list or bug
|
|
201 |
tracker, see
|
|
202 |
<literal>http://www.freedesktop.org/software/dbus/</literal>
|
|
203 |
</para>
|
|
204 |
</refsect1>
|
|
205 |
</refentry>
|