xref: /aosp_15_r20/external/giflib/doc/giftext.xml (revision 324bb76b8d05e2a05aa88511fff61cf3f9ca5892)
1<?xml version="1.0" encoding="ISO-8859-1"?>
2<!DOCTYPE refentry PUBLIC
3   "-//OASIS//DTD DocBook XML V4.1.2//EN"
4   "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd" []>
5<refentry id='giftext.1'>
6<refentryinfo><date>2 May 2012</date></refentryinfo>
7<refmeta>
8<refentrytitle>giftext</refentrytitle>
9<manvolnum>1</manvolnum>
10<refmiscinfo class="source">GIFLIB</refmiscinfo>
11<refmiscinfo class="manual">GIFLIB Documentation</refmiscinfo>
12</refmeta>
13<refnamediv id='name'>
14<refname>giftext</refname>
15<refpurpose>dump GIF pixels and metadata as text</refpurpose>
16</refnamediv>
17
18<refsynopsisdiv id='synopsis'>
19
20<cmdsynopsis>
21  <command>giftext</command>
22      <arg choice='opt'>-v</arg>
23      <arg choice='opt'>-c</arg>
24      <arg choice='opt'>-e</arg>
25      <arg choice='opt'>-z</arg>
26      <arg choice='opt'>-p</arg>
27      <arg choice='opt'>-r</arg>
28      <arg choice='opt'>-h</arg>
29      <arg choice='opt'><replaceable>gif-file</replaceable></arg>
30</cmdsynopsis>
31</refsynopsisdiv>
32
33<refsect1><title>Description</title>
34
35<para>A program to dump (text only) general information about GIF file.</para>
36
37<para>If no GIF file is given, giftext will try to read a GIF file
38from stdin.</para>
39
40</refsect1>
41<refsect1><title>Options</title>
42
43<variablelist>
44<varlistentry>
45<term>-v</term>
46<listitem>
47<para> Verbose mode (show progress).
48Enables printout of running scan lines. </para>
49</listitem>
50</varlistentry>
51
52<varlistentry>
53<term>-c</term>
54<listitem>
55<para> Dumps the color maps.</para>
56</listitem>
57</varlistentry>
58
59<varlistentry>
60<term>-e</term>
61<listitem>
62<para> Dumps encoded bytes - the pixels after compressed using LZ
63algorithm and chained to form bytes.  This is the form the data is
64saved in the GIF file.  Dumps in hex - 2 digit per byte.</para>
65</listitem>
66</varlistentry>
67
68<varlistentry>
69<term>-z</term>
70<listitem>
71<para> Dumps the LZ codes of the image.  Dumps in hex - 3 digits per
72code (as we are limited to 12 bits).</para>
73</listitem>
74</varlistentry>
75
76<varlistentry>
77<term>-p</term>
78<listitem>
79<para> Dumps the pixels of the image.  Dumps in hex - 2 digit per
80pixel (&lt;=byte).</para>
81</listitem>
82</varlistentry>
83
84<varlistentry>
85<term>-r</term>
86<listitem>
87<para> Dumps raw pixels as one byte per pixel.  This option inhibits
88all other options and only the pixels are dumped.  This option may be
89used to convert GIF files into raw data.  Note: the color map can be
90extracted by gifclrmp utility.  If more than one image is included in
91the file, all images will be dumped in order.</para>
92</listitem>
93</varlistentry>
94
95<varlistentry>
96<term>-h</term>
97<listitem>
98<para> Print one line of command line help, similar to Usage
99above.</para>
100</listitem>
101</varlistentry>
102</variablelist>
103
104</refsect1>
105<refsect1><title>Author</title>
106
107<para>Gershon Elber.</para>
108
109</refsect1>
110</refentry>
111