diff options
author | Romain Bouvier <skunnyk@alteroot.org> | 2020-06-03 00:30:27 +0200 |
---|---|---|
committer | Romain Bouvier <skunnyk@alteroot.org> | 2020-06-04 19:52:47 +0200 |
commit | e19cc0f79b3a577ef1e3ab1220c47ed640362a6e (patch) | |
tree | 42d583e96d52d90bbd298d6f694ce2d65577fd61 /docs | |
parent | 4531a96c9a77ab225aaeb472a7c7642e2e7dcb38 (diff) | |
download | xfce4-dev-tools-e19cc0f79b3a577ef1e3ab1220c47ed640362a6e.tar.gz |
Add manpage and tests to xdt-csource
- Migrated from the old-csource
- Needed to completely remove exo-csource from exo
Diffstat (limited to 'docs')
-rw-r--r-- | docs/Makefile.am | 13 | ||||
-rw-r--r-- | docs/xdt-csource.xml | 160 |
2 files changed, 173 insertions, 0 deletions
diff --git a/docs/Makefile.am b/docs/Makefile.am new file mode 100644 index 0000000..23c8647 --- /dev/null +++ b/docs/Makefile.am @@ -0,0 +1,13 @@ +man_MANS = \ + xdt-csource.1 + +if MAINTAINER_MODE +%.1: %.xml + xsltproc --nonet http://docbook.sourceforge.net/release/xsl/current/manpages/docbook.xsl $< +endif + +EXTRA_DIST = \ + $(man_MANS) \ + xdt-csource.xml + +# vi:set ts=8 sw=8 noet ai softtabstop=0 syntax=automake: diff --git a/docs/xdt-csource.xml b/docs/xdt-csource.xml new file mode 100644 index 0000000..bd5156c --- /dev/null +++ b/docs/xdt-csource.xml @@ -0,0 +1,160 @@ +<!-- + + Copyright (c) 2005 os-cillation + Copyright (c) 2020 Xfce Developement Team + + Written by Benedikt Meurer <benny@xfce.org>. +--> + +<refentry id="xdt-csource"> + <refmeta> + <refentrytitle>xdt-csource</refentrytitle> + <manvolnum>1</manvolnum> + <refmiscinfo class="manual">Xfce User's Manual</refmiscinfo> + <refmiscinfo class="source">Xfce</refmiscinfo> + </refmeta> + + <refnamediv> + <refname>xdt-csource</refname> + <refpurpose>C code generation utility for arbitrary data</refpurpose> + </refnamediv> + + <refsynopsisdiv> + <cmdsynopsis> + <command>xdt-csource</command> + <arg choice="opt">options</arg> + <arg choice="opt">file</arg> + </cmdsynopsis> + <cmdsynopsis> + <command>xdt-csource</command> + <arg choice="opt">options</arg> + <arg choice="plain">--build-list</arg> + <arg rep="repeat"> + <arg>name</arg> + <arg>file</arg> + </arg> + </cmdsynopsis> + </refsynopsisdiv> + + <refsect1> + <title>Description</title> + <para> + <command>xdt-csource</command> is a small utility that generates C code + containing arbitrary data, useful for compiling texts or other data + directly into programs. It supersedes exo-csource. + </para> + </refsect1> + + <refsect1> + <title>Invocation</title> + <para> + <command>xdt-csource</command> either takes as input one file name to + generate code for, or, using the <option>--build-list</option> option, + a list of (<replaceable>name</replaceable>, <replaceable>file</replaceable>) + pairs to generate code for a list of images into named variables. + </para> + + <refsect2> + <title>Options</title> + <variablelist> + <varlistentry> + <term><option>-h</option>, <option>--help</option></term> + <listitem> + <para>Print brief help and exit.</para> + </listitem> + </varlistentry> + + <varlistentry> + <term><option>-V</option>, <option>--version</option></term> + <listitem> + <para>Print version information and exit.</para> + </listitem> + </varlistentry> + + <varlistentry> + <term><option>--extern</option></term> + <listitem> + <para>Generate extern symbols.</para> + </listitem> + </varlistentry> + + <varlistentry> + <term><option>--static</option></term> + <listitem> + <para>Generate static symbols (default).</para> + </listitem> + </varlistentry> + + <varlistentry> + <term><option>--name=identifier</option></term> + <listitem> + <para> + Specifies the <parameter>identifier</parameter> name (prefix) for the + generated variables (only used if <option>--build-list</option> was + not specified as well). + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term><option>--build-list</option></term> + <listitem> + <para> + Enables (<replaceable>name</replaceable>, <replaceable>file</replaceable>) + pair parsing mode. + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term><option>--strip-comments</option></term> + <listitem> + <para> + Remove comments from XML files + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term><option>--strip-content</option></term> + <listitem> + <para> + Remove node contents from XML files + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term><option>--output=identifier</option></term> + <listitem> + <para> + Prints the output to <parameter>identifier</parameter> instead of + stdout (only used if <option>--build-list</option> was + not specified as well). + </para> + </listitem> + </varlistentry> + </variablelist> + </refsect2> + </refsect1> + + <refsect1> + <title>See also</title> + <para> + The <command>gdk-pixbuf-csource</command> utility which ships with the Gtk+ + distribution, available from <ulink url="https://www.gtk.org">www.gtk.org</ulink>. + </para> + </refsect1> + + <refsect1> + <title>Author</title> + <para> + Original program <command>exo-csource</command> was written by Benedikt Meurer + <email>benny@xfce.org</email>. + <command>xdt-csource</command> supersedes it. + </para> + <para> + This manual page was provided by the Xfce Development Team <email>xfce4-dev@xfce.org</email>. + </para> + </refsect1> +</refentry> |