File: xdt-csource.xml

package info (click to toggle)
xfce4-dev-tools 4.20.0-2
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 1,976 kB
  • sloc: sh: 5,180; ansic: 404; xml: 137; python: 128; makefile: 109
file content (160 lines) | stat: -rw-r--r-- 4,738 bytes parent folder | download | duplicates (3)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
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>