Mercurial > repos > rliterman > csp2

comparison CSP2/CSP2_env/env-d9b9114564458d9d-741b3de822f2aaca6c6caa4325c4afce/share/man/man1/gifbuild.1 @ 68:5028fdace37b

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
planemo upload commit 2e9511a184a1ca667c7be0c6321a36dc4e3d116d
author jpayne
date Tue, 18 Mar 2025 16:23:26 -0400
parents
children
comparison
equal deleted inserted replaced
67:0e9998148a16 68:5028fdace37b
1 '\" t
2 .\" Title: gifbuild
3 .\" Author: [see the "Author" section]
4 .\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
5 .\" Date: 2 May 2012
6 .\" Manual: GIFLIB Documentation
7 .\" Source: GIFLIB
8 .\" Language: English
9 .\"
10 .TH "GIFBUILD" "1" "2 May 2012" "GIFLIB" "GIFLIB Documentation"
11 .\" -----------------------------------------------------------------
12 .\" * Define some portability stuff
13 .\" -----------------------------------------------------------------
14 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
15 .\" http://bugs.debian.org/507673
16 .\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
17 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
18 .ie \n(.g .ds Aq \(aq
19 .el .ds Aq '
20 .\" -----------------------------------------------------------------
21 .\" * set default formatting
22 .\" -----------------------------------------------------------------
23 .\" disable hyphenation
24 .nh
25 .\" disable justification (adjust text to left margin only)
26 .ad l
27 .\" -----------------------------------------------------------------
28 .\" * MAIN CONTENT STARTS HERE *
29 .\" -----------------------------------------------------------------
30 .SH "NAME"
31 gifbuild \- dump GIF data in a textual format, or undump it to a GIF
32 .SH "SYNOPSIS"
33 .HP \w'\fBgifbuild\fR\ 'u
34 \fBgifbuild\fR [\-v] [\-a] [\-d] [\-t\ \fItranslation\-table\fR] [\-h] [\fIgif\-file\fR]
35 .SH "OPTIONS"
36 .PP
37 A program to convert a series of editable text GIF icon specifications and named GIF files into a multi\-image GIF, usable as a graphic resource file\&. It can also dump existing GIFs in this format\&. When dumping a GIF, certain sanity checks are performed which may result in a warning emitted to standard error\&.
38 .PP
39 If no GIF file is given, gifbuild will try to read a text input from stdin\&.
40 .SH "SPECIFICATION SYNTAX"
41 .PP
42 Here is a syntax summary in informal BNF\&. The token `NL\*(Aq represents a required newline\&.
43 .sp
44 .if n \{\
45 .RS 4
46 .\}
47 .nf
48 <gif\-spec> ::= <header\-block> <image\-block>\&.\&.\&.
49
50 <header\-block> ::= <header\-declaration>\&.\&.\&.
51
52 <header\-declaration ::=
53 | screen width <digits> NL
54 | screen height <digits> NL
55 | screen colors <digits> NL
56 | screen background <digits> NL
57 | pixel aspect byte <digits> NL
58 | screen map <color\-table> NL
59
60 <color\-table> ::= <color\-declaration>\&.\&.\&. end NL
61
62 <color\-declaration> ::= rgb <digits> <digits> <digits> [ is <key>] NL
63 | sort flag {on|off} NL
64
65 <image\-block> ::= include <file\-name> NL
66 | image NL
67 <image\-declaration>\&.\&.\&.
68 <raster\-picture>
69 [ <extension> ]
70
71 <image\-declarations> ::= image top <digits> NL
72 | image left <digits> NL
73 | image interlaced NL
74 | image map <color\-table> NL
75 | image bits <digits> by <digits> [hex|ascii] NL <raster\-block>
76
77 <extension> := <comment> NL <extension\-block> NL end NL
78 | <plaintext> NL <extension\-block> NL end NL
79 | graphics control NL <GCB\-part> NL end NL
80 | netscape loop <digits> NL
81 | extension <hex\-digits> NL <extension\-block> NL end NL
82
83 <GCB\-part> ::= disposal mode <digits> NL
84 | user input flag {on|off} NL
85 | delay <digits> NL
86 | transparent index <digits> NL
87
88 .fi
89 .if n \{\
90 .RE
91 .\}
92 .PP
93 If the data types of the
94 \(lqscreen height\(rq,
95 \(lqscreen width\(rq,
96 \(lqscreen background\(rq,
97 \(lqimage top\(rq, and
98 \(lqimage left\(rq
99 declarations aren\*(Aqt obvious to you, what are you doing with this software?
100 .PP
101 The
102 \(lqpixel aspect byte\(rq
103 declaration sets an integer denominator for a fraction expressing the puxel aspect ratio\&. See the GIF standard for details; this field is actually long obsolete\&.
104 .PP
105 A color table declares color indices (in ascending order from 0) and may associate them with key characters (these associations are absent when the map is more than 94 colors lang and raster blocks using it must use hex pairs)\&. These characters can later be used in raster blocks\&. As these must be printable and non\-whitespace, you can only specify 94 colors per icon\&. Life is like that sometimes\&.
106 .PP
107 A color table declaration can also set the table\*(Aqs sort flag with "sort flag on" or "sort flag off" on any line before the end\&.
108 .PP
109 An
110 \(lqascii\(rq
111 raster block is just a block of key characters (used for a color map of 94 or fewer colors)\&. A
112 \(lqhex\(rq
113 raster block uses hex digit pairs instead (used for a color map with more than 94 colors)\&. The default is ASCII\&. It should be sized correctly for the
114 \(lqimage bits\(rq
115 declaration that leads it\&. Raster blocks from interlaced GIFs are dumped with the lines in non\-interlaced order\&.
116 .PP
117 The
118 \(lqcomment\(rq,
119 \(lqplaintext\(rq
120 or
121 \(lqggraphics control\(rq
122 keywords lead defined GIF89 extension record data\&. The final GIF89 type, graphics control and application block, are not yet supported, but the code does recognize a Netscape loop block\&. You can also say
123 \(lqextension\(rq
124 followed by a hexadecimal record type\&. All of these extension declarations must be followed by an extension block, which is terminated by the keyword
125 \(lqend\(rq
126 on its own line\&.
127 .PP
128 An extension block is a series of text lines, each interpreted as a string of bytes to fill an extension block (the terminating newline is stripped)\&. Text may include standard C\-style octal and hex escapes preceded by a backslash\&.
129 .PP
130 A graphics control block declaration creates a graphics control extension block; for the field semantics see the GIF89 standard, part 23\&.
131 .PP
132 A netscape loop declaration creates an application extension block containing a NETSCAPE 2\&.0 animation loop control with a specified repeat count (repeat count 0 means loop forever)\&. This must be immediately after the header declaration\&. These loop blocks are interpreted by the Netscape/Mozilla/Firefox line of browsers\&.
133 .PP
134 All <digits> tokens are interpreted as decimal numerals; <hex\-digits> tokens are interpreted as two hex digits (a byte)\&. All coordinates are zero\-origin with the top left corner (0,0)\&. Range checking is weak and signedness checking nonexistent; caveat hacker!
135 .PP
136 In general, the amount of whitespace and order of declarations within a header or image block is not significant, except that a raster picture must immediately follow its
137 \(lqimage bits\(rq
138 bits declaration\&.
139 .PP
140 The
141 \(lqinclude\(rq
142 declaration includes a named GIF as the next image\&. The global color maps of included GIFs are merged with the base table defined by any
143 \(lqscreen color\(rq
144 declaration\&. All images of an included multi\-image GIF will be included in order\&.
145 .PP
146 Comments (preceded with
147 \(lq#\(rq) will be ignored\&.
148 .SH "OPTIONS"
149 .PP
150 \-v
151 .RS 4
152 Verbose mode (show progress)\&. Enables printout of running scan lines\&.
153 .RE
154 .PP
155 \-d
156 .RS 4
157 Dump the input GIF file(s) into the text form described above\&.
158 .RE
159 .PP
160 \-t
161 .RS 4
162 Specify name characters to use when dumping raster blocks\&. Only valid with \-d option\&.
163 .RE
164 .PP
165 \-h
166 .RS 4
167 Print one line of command line help, similar to Usage above\&.
168 .RE
169 .SH "BUGS"
170 .PP
171 Error checking is rudimentary\&.
172 .SH "EXAMPLE:"
173 .PP
174 A sample icon file called
175 sample\&.ico
176 is included in the pic directory of the GIFLIB source distribution\&.
177 .SH "AUTHOR"
178 .PP
179 Eric S\&. Raymond
180 <esr@thyrsus\&.com>