"Initial commit to Gerrit"
[profile/ivi/libgsf.git] / doc / gsf.1
1 .de URL
2 \\$2 \(laURL: \\$1 \(ra\\$3
3 ..
4 .if \n[.g] .mso www.tmac
5 .TH GSF 1 "29 November 2009" gsf "GNOME"
6 .SH NAME
7 gsf \- archiving utility using the G Structured File library
8
9 .SH SYNOPSIS
10 \fBgsf\fR [\fIOPTION...\fR] \fISUBCOMMAND\fR \fIARCHIVE...\fR
11
12 .SH DESCRIPTION
13 This manual page briefly documents the \fBgsf\fR command.
14
15 \fBgsf\fR is a simple archive utility, somewhat similar to \fBtar\fR(1). It
16 operates on files following one of the structured file formats understood by
17 the G Structured File library, for example, Microsoft Excel(TM) files.
18
19 .\".SH "RETURN VALUE"
20 .\".SH "EXIT STATUS"
21 .\".SH "ERROR HANDLING"
22 .\".SH ERRORS
23 .SH OPTIONS
24 .SS "Options"
25 .TP
26 .B \-?, \-\-help
27 Show help options
28 .TP
29 .B \-v, \-\-version
30 Display gsf's version
31
32 .SS "Subcommands"
33 .TP
34 .B cat
35 Output one or more files in archive
36 .TP
37 .B dump
38 Dump one or more files in archive as formatted hexadecimal
39 .TP
40 .B help
41 List subcommands
42 .TP
43 .B list
44 List files in archive
45 .TP
46 .B props
47 Archive list of property names
48
49 .\".SH USAGE
50 .SH EXAMPLES
51 To list the content structure of a Microsoft Excel(TM) file \fIarrays.xls\fR:
52 .PP
53 gsf list arrays.xls
54 .PP
55 To dump Workbook, an individual data stream in arrays.xls:
56 .PP
57 gsf dump arrays.xls Workbook
58 .PP
59 .\".SH FILES
60 .\".SH ENVIRONMENT
61 .\".SH DIAGNOSTICS
62 .\".SH SECURITY
63 .\".SH CONFORMING TO
64 .\".SH NOTES
65 .\".SH BUGS
66
67 .\".SH LICENSE
68 .\"
69 .\"\fBgsf-office-thumbnailer\fR is licensed under the terms of version 2.1 of
70 .\"the GNU Lesser General Public License (LGPL) as published by the Free
71 .\"Software Foundation. For information on this license look at the source code
72 .\"that came with the software or see the
73 .\".UR http://www.gnu.org
74 .\"GNU project page
75 .\".UE
76 .\"at http://www.gnu.org/.
77
78 .SH AUTHORS
79
80 \fBgsf\fR's primary authors are Morten Welinder <terra@gnome.org> and Jody
81 Goldberg <jody@gnome.org>.
82
83 The initial version of this manpage was written by J.H.M. Dassen (Ray)
84 <jdassen@debian.org>.
85
86 .SH SEE ALSO
87 \fBgnumeric\fR(1)
88
89 .URL "http://www.gnome.org/projects/gnumeric/" "The Gnumeric homepage"
90
91 .URL "http://www.gnome.org/" "The GNOME project page"