aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorEmil Velikov <emil.velikov@collabora.com>2021-07-12 18:41:41 +0100
committerEmil Velikov <emil.l.velikov@gmail.com>2021-07-12 18:45:13 +0100
commite2de20cae38383d4bdc64a05ebc52bd5800733f7 (patch)
treed94656893cfc000ba022088d20b581edc3f33fe8
parent6c28e5f1c018b2a972c8c3d35344df6af52ba579 (diff)
downloadwaffle-e2de20cae38383d4bdc64a05ebc52bd5800733f7.tar.gz
wflinfo: doc: use space separator for longopts
Current implementation supports space separated short and long opts. Additionally it handles space-less short opts and = long opts. The latter two are less common and adding support for them in the shell completion is cumbersome. So drop them from the --help and man pages. The program still supports them so existing users will still work. Signed-off-by: Emil Velikov <emil.velikov@collabora.com>
-rw-r--r--man/wflinfo.1.xml26
-rw-r--r--src/utils/wflinfo.c10
2 files changed, 18 insertions, 18 deletions
diff --git a/man/wflinfo.1.xml b/man/wflinfo.1.xml
index 2f54aaa..30327fc 100644
--- a/man/wflinfo.1.xml
+++ b/man/wflinfo.1.xml
@@ -38,10 +38,10 @@
<cmdsynopsis>
<command>wflinfo</command>
<arg choice="plain">
- <option>--platform=<replaceable class="parameter">platform</replaceable></option>
+ <option>--platform</option> <replaceable class="parameter">platform</replaceable>
</arg>
<arg choice="plain">
- <option>--api=<replaceable class="parameter">api</replaceable></option>
+ <option>--api</option> <replaceable class="parameter">api</replaceable>
</arg>
<arg choice="opt">
<option><replaceable class="parameter">OPTIONS</replaceable></option>
@@ -65,7 +65,7 @@
<variablelist>
<varlistentry>
<term><option>-p</option> <replaceable class="parameter">platform</replaceable></term>
- <term><option>--platform=<replaceable class="parameter">platform</replaceable></option></term>
+ <term><option>--platform</option> <replaceable class="parameter">platform</replaceable></term>
<listitem>
<para>
Where <replaceable class="parameter">platform</replaceable> is
@@ -85,7 +85,7 @@
</varlistentry>
<varlistentry>
<term><option>-a</option> <replaceable class="parameter">api</replaceable></term>
- <term><option>--api=<replaceable class="parameter">api</replaceable></option></term>
+ <term><option>--api</option> <replaceable class="parameter">api</replaceable></term>
<listitem>
<para>
Where <replaceable class="parameter">api</replaceable> is
@@ -108,15 +108,15 @@
<variablelist>
<varlistentry>
<term><option>-V</option> <replaceable class="parameter">MAJOR.MINOR</replaceable></term>
- <term><option>--version=<replaceable class="parameter">MAJOR.MINOR</replaceable></option></term>
+ <term><option>--version</option> <replaceable class="parameter">MAJOR.MINOR</replaceable></term>
<listitem>
<para>
- For example --api=gl --version=3.2 would request OpenGL 3.2
+ For example --api gl --version 3.2 would request OpenGL 3.2
</para>
</listitem>
</varlistentry>
<varlistentry>
- <term><option>--profile=<replaceable class="parameter">profile</replaceable></option></term>
+ <term><option>--profile</option> <replaceable class="parameter">profile</replaceable></term>
<listitem>
<para>
Where <replaceable class="parameter">profile</replaceable> is core, compat or none
@@ -149,8 +149,8 @@
</listitem>
</varlistentry>
<varlistentry>
- <term><option>-f <replaceable class="parameter">format</replaceable></option></term>
- <term><option>--format=<replaceable class="parameter">format</replaceable></option></term>
+ <term><option>-f</option> <replaceable class="parameter">format</replaceable></term>
+ <term><option>--format</option> <replaceable class="parameter">format</replaceable></term>
<listitem>
<para>
Choose the output format. Supported formats are 'original' (the default) and 'json'.
@@ -178,10 +178,10 @@
<para>
<simplelist>
- <member>wflinfo --platform=glx --api=gl</member>
- <member>wflinfo --platform=x11_egl --api=gl --version=3.2 --profile=core</member>
- <member>wflinfo --platform=wayland --api=gles3</member>
- <member>wflinfo --platform=gbm --api=gl --version=3.2 --verbose</member>
+ <member>wflinfo --platform glx --api gl</member>
+ <member>wflinfo --platform x11_egl --api gl --version 3.2 --profile core</member>
+ <member>wflinfo --platform wayland --api gles3</member>
+ <member>wflinfo --platform gbm --api gl --version 3.2 --verbose</member>
<member>wflinfo -p gbm -a gl -V 3.2 -v</member>
</simplelist>
</para>
diff --git a/src/utils/wflinfo.c b/src/utils/wflinfo.c
index 1cac580..59937f5 100644
--- a/src/utils/wflinfo.c
+++ b/src/utils/wflinfo.c
@@ -72,7 +72,7 @@ static const char *usage_message =
"\n"
"Options:\n"
" -V, --version <version>\n"
- " For example --api=gl --version=3.2 would request OpenGL 3.2.\n"
+ " For example --api gl --version 3.2 would request OpenGL 3.2.\n"
"\n"
" --profile <profile>\n"
" One of: core, compat or none\n"
@@ -93,10 +93,10 @@ static const char *usage_message =
" Print wflinfo usage information.\n"
"\n"
"Examples:\n"
- " wflinfo --platform=glx --api=gl\n"
- " wflinfo --platform=x11_egl --api=gl --version=3.2 --profile=core\n"
- " wflinfo --platform=wayland --api=gles3\n"
- " wflinfo --platform=gbm --api=gl --version=3.2 --verbose\n"
+ " wflinfo --platform glx --api gl\n"
+ " wflinfo --platform x11_egl --api gl --version 3.2 --profile core\n"
+ " wflinfo --platform wayland --api gles3\n"
+ " wflinfo --platform gbm --api gl --version 3.2 --verbose\n"
" wflinfo -p gbm -a gl -V 3.2 -v\n"
;