Debian Codegraph @

doc/tools.html

raw
1 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
2 <html><head><meta content="text/html; charset=ISO-8859-1" http-equiv="content-type">
3
4 <title>Geners Tools</title></head><body>
5 <h2 style="text-align: center;">Geners Tools</h2>
6 The "tools" subdirectory of the "geners" package includes several
7 programs which can be used to examine the contents of object archives
8 and catalogs. By default, these programs are compiled during the normal
9 package installation procedure but they are not installed in any other
10 location on your computer. If invoked without any arguments, each
11 program prints its usage instructions to the standard output.<br>
12
13 <br>
14 <span style="font-family: Courier New,Courier,monospace; color: rgb(0, 153, 0);">cdump</span>
15 &mdash; "Catalog dump". This program can be used to print catalog contents
16 to the standard output and to collect item type summaries.<br>
17 <br style="font-family: Courier New,Courier,monospace; color: rgb(0, 153, 0);">
18 <span style="font-family: Courier New,Courier,monospace; color: rgb(0, 153, 0);">gssa_dump</span>
19 &mdash; "Catalog dump for .gssa or .gssaz files". This program can be used
20 to print catalogs of string archives saved in dedicated binary files. The convention
21 here is to use extension .gssa (Generic Serialization String Archive) for such
22 files without compression and .gssaz with compression.<br>
23 <br style="color: rgb(0, 153, 0);">
24 <span style="font-family: Courier New,Courier,monospace; color: rgb(0, 153, 0);">cmerge</span>
25 &mdash; "Catalog merge". This program can be used to merge contents of
26 multiple catalogs. The resulting catalog can be treated as a single
27 combined "geners" archive. Object data files included as members of the
28 new combined archive do not have to be modified.<br>
29 <br style="color: rgb(0, 153, 0);">
30 <span style="font-family: Courier New,Courier,monospace; color: rgb(0, 153, 0);">gssa_merge</span>
31 &mdash; "String archive merge". This program can be used to merge contents of
32 multiple .gssa or .gssaz files into a single archive.<br>
33 <br style="color: rgb(0, 153, 0);">
34 <span style="font-family: Courier New,Courier,monospace; color: rgb(0, 153, 0);">crecover</span>
35 &mdash; "Catalog recover". This program can be used to recover catalog data
36 from binary archive data files if a copy of the catalog was merged into
37 the data stream. This mode of archive operation is useful mainly in the
38 code development process, so that the catalog can be recovered in case
39 of an unexpected program crash.<br>
40 <br style="color: rgb(0, 153, 0);">
41 <span style="font-family: Courier New,Courier,monospace; color: rgb(0, 153, 0);">print_items</span>
42 &mdash; This program can be used to fetch items from an archive and to print
43 them to the standard output. It is expected that this particular
44 program will be extended by the users as they develop their own classes
45 (see comments at the beginning of file "print_items.cc"). In its
46 original form, the program can only print C++ strings and built-in
47 numeric types.<br>
48 <br style="color: rgb(0, 153, 0);">
49 <span style="font-family: Courier New,Courier,monospace; color: rgb(0, 153, 0);">template_io_boilerplate</span>
50 &mdash; This program generates a boilerplate header file for serializing
51 templates that can not be modified by the user (<i>i.e.</i>, coming from an external library).<br>
52 <br>
53 </body></html>