nexmon – Blame information for rev 1

Subversion Repositories:
Rev:
Rev Author Line No. Line
1 office 1 <refentry id="gresource-tool" lang="en">
2  
3 <refentryinfo>
4 <title>gresource</title>
5 <productname>GIO</productname>
6 <authorgroup>
7 <author>
8 <contrib>Developer</contrib>
9 <firstname>Matthias</firstname>
10 <surname>Clasen</surname>
11 </author>
12 </authorgroup>
13 </refentryinfo>
14  
15 <refmeta>
16 <refentrytitle>gresource</refentrytitle>
17 <manvolnum>1</manvolnum>
18 <refmiscinfo class="manual">User Commands</refmiscinfo>
19 </refmeta>
20  
21 <refnamediv>
22 <refname>gresource</refname>
23 <refpurpose>GResource tool</refpurpose>
24 </refnamediv>
25  
26 <refsynopsisdiv>
27 <cmdsynopsis>
28 <command>gresource</command>
29 <arg choice="opt">--section <replaceable>SECTION</replaceable></arg>
30 <arg choice="plain">list</arg>
31 <arg choice="plain"><replaceable>FILE</replaceable></arg>
32 <arg choice="opt"><replaceable>PATH</replaceable></arg>
33 </cmdsynopsis>
34 <cmdsynopsis>
35 <command>gresource</command>
36 <arg choice="opt">--section <replaceable>SECTION</replaceable></arg>
37 <arg choice="plain">details</arg>
38 <arg choice="plain"><replaceable>FILE</replaceable></arg>
39 <arg choice="opt"><replaceable>PATH</replaceable></arg>
40 </cmdsynopsis>
41 <cmdsynopsis>
42 <command>gresource</command>
43 <arg choice="opt">--section <replaceable>SECTION</replaceable></arg>
44 <arg choice="plain">extract</arg>
45 <arg choice="plain"><replaceable>FILE</replaceable></arg>
46 <arg choice="plain"><replaceable>PATH</replaceable></arg>
47 </cmdsynopsis>
48 <cmdsynopsis>
49 <command>gresource</command>
50 <arg choice="plain">sections</arg>
51 <arg choice="plain"><replaceable>FILE</replaceable></arg>
52 </cmdsynopsis>
53 <cmdsynopsis>
54 <command>gresource</command>
55 <arg choice="plain">help</arg>
56 <arg choice="opt"><replaceable>COMMAND</replaceable></arg>
57 </cmdsynopsis>
58 </refsynopsisdiv>
59  
60 <refsect1><title>Description</title>
61 <para><command>gresource</command> offers a simple commandline
62 interface to <link linkend="GResource"><type>GResource</type></link>.
63 It lets you list and extract resources that have been compiled
64 into a resource file or included in an elf file (a binary or a
65 shared library).
66 </para>
67 <para>
68 The file to operate on is specified by the <replaceable>FILE</replaceable>
69 argument.
70 </para>
71 <para>
72 If an elf file includes multiple sections with resources, it is
73 possible to select which one to operate on with the
74 <arg choice="plain">--section</arg> option. Use the
75 <arg choice="plain">sections</arg> command to find available sections.
76 </para>
77 </refsect1>
78  
79 <refsect1><title>Commands</title>
80 <variablelist>
81  
82 <varlistentry>
83 <term><option>list</option></term>
84 <listitem><para>
85 Lists resources. If <replaceable>SECTION</replaceable> is given, only
86 list resourcs in this section. If <replaceable>PATH</replaceable> is
87 given, only list matching resources.
88 </para></listitem>
89 </varlistentry>
90  
91 <varlistentry>
92 <term><option>details</option></term>
93 <listitem><para>
94 Lists resources with details. If <replaceable>SECTION</replaceable>
95 is given, only list resources in this section. If
96 <replaceable>PATH</replaceable> is given, only list matching resources.
97 Details include the section, size and compression of each resource.
98 </para></listitem>
99 </varlistentry>
100  
101 <varlistentry>
102 <term><option>extract</option></term>
103 <listitem><para>
104 Extracts the resource named by <replaceable>PATH</replaceable> to stdout.
105 Note that resources may contain binary data.
106 </para></listitem>
107 </varlistentry>
108  
109 <varlistentry>
110 <term><option>sections</option></term>
111 <listitem><para>
112 Lists sections containing resources. This is only interesting if
113 <replaceable>FILE</replaceable> is an elf file.
114 </para></listitem>
115 </varlistentry>
116  
117 <varlistentry>
118 <term><option>help</option></term>
119 <listitem><para>
120 Prints help and exits.
121 </para></listitem>
122 </varlistentry>
123  
124 </variablelist>
125  
126 </refsect1>
127 </refentry>