system/systemd
system/systemd
1
0
Fork 0
mirror of https://github.com/systemd/systemd synced 2024-10-06 16:21:34 +00:00
Code Issues Packages Projects Releases Wiki Activity

systemd-id128: properly document the show verb

Browse source 
https://github.com/systemd/systemd/issues/27514 requested this functionality
among other things, but it is already implemented. The man page was also
missing 'show' in the synopsis, so add that, along with an example.
This commit is contained in:
Zbigniew Jędrzejewski-Szmek 2023-08-26 13:29:01 +02:00
parent b5c27ebca4
commit f4e518e812
2 changed files with 32 additions and 5 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

35
man/systemd-id128.xml
View file

@ -44,6 +44,13 @@
<arg choice="opt" rep="repeat">OPTIONS</arg>
<arg choice="plain">invocation-id</arg>
</cmdsynopsis>
<cmdsynopsis>
<command>systemd-id128</command>
<arg choice="opt" rep="repeat">OPTIONS</arg>
<arg choice="plain">show</arg>
<arg choice="opt" rep="repeat">NAME|UUID</arg>
</cmdsynopsis>
</refsynopsisdiv>
<refsect1>
@ -76,9 +83,10 @@
<para>With <command>show</command>, well-known IDs are printed (for now, only GPT partition type UUIDs),
along with brief identifier strings. When no arguments are specified, all known IDs are shown. When
arguments are specified, they must be the identifiers or ID values of one or more known IDs, which are
then printed. Combine with <option>--uuid</option> to list the IDs in UUID style, i.e. the way GPT
partition type UUIDs are usually shown.</para>
arguments are specified, they may be the identifiers or ID values of one or more known IDs, which are
then printed with their name, or arbitrary IDs, which are then printed with a placeholder name. Combine
with <option>--uuid</option> to list the IDs in UUID style, i.e. the way GPT partition type UUIDs are
usually shown.</para>
</refsect1>
<refsect1>
@ -137,7 +145,26 @@
<refsect1>
<title>Exit status</title>
<para>On success, 0 is returned, a non-zero failure code otherwise.</para>
<para>On success 0 is returned, and a non-zero failure code otherwise.</para>
</refsect1>
<refsect1>
<title>Examples</title>
<example>
<title>Show a well-known UUID</title>
<programlisting>
$ systemd-id128 show -P user-home
773f91ef66d449b5bd83d683bf40ad16
$ systemd-id128 show -Pu user-home
773f91ef-66d4-49b5-bd83-d683bf40ad16
$ systemd-id128 show 773f91ef-66d4-49b5-bd83-d683bf40ad16
NAME ID
user-home 773f91ef66d449b5bd83d683bf40ad16
</programlisting>
</example>
</refsect1>
<refsect1>

2
src/id128/id128.c
View file

@ -166,7 +166,7 @@ static int help(void) {
" machine-id Print the ID of current machine\n"
" boot-id Print the ID of current boot\n"
" invocation-id Print the ID of current invocation\n"
" show [NAME] Print one or more well-known GPT partition type IDs\n"
" show [NAME|UUID] Print one or more UUIDs\n"
" help Show this help\n"
"\nOptions:\n"
" -h --help Show this help\n"