doc/ssindex.1

   1 .de URL
   2 \\$2 \(laURL: \\$1 \(ra\\$3
   3 ..
   4 .if \n[.g] .mso www.tmac
   5 .TH SSINDEX 1 "2009-02-08" gnumeric "GNOME"
   6 .SH NAME
   7 ssindex \- generate index data for spreadsheet files
   8
   9 .SH SYNOPSIS
  10 \fBssindex \fR [\fIOPTIONS\fR] [\fIFILES\fR]
  11
  12 .SH DESCRIPTION
  13 This manual page briefly documents the \fBssindex\fR command.
  14
  15 \fBssindex\fR is a command line utility to generate index data for
  16 various spreadsheet file formats. It is primarily used by the \fBBeagle\fR
  17 indexing sub-system and search aggregator.
  18
  19 .\".SH "RETURN VALUE"
  20 .\".SH "EXIT STATUS"
  21 .\".SH ERRORS
  22 .SH OPTIONS
  23 This program follows the usual GNU command line syntax, with single
  24 letter options starting with a single dash (`-') and longer options
  25 starting with two dashes (`--').
  26
  27 .SS "Main options"
  28 .TP
  29 .B \-E, \-\-import\-encoding=\fIENCODING\fR
  30 Specify an encoding for imported content
  31 .TP
  32 .B \-i, \-\-index
  33 Index the given files
  34 .TP
  35 .B \-m, \-\-list\-mime\-types
  36 List the MIME types which ssindex is able to read
  37
  38 .SS "Help options"
  39 .TP
  40 .B \-v, \-\-version
  41 Display ssindex's version
  42 .TP
  43 .B \-?, \-\-help
  44 Display the supported options
  45 .TP
  46 .B \-\-usage
  47 Display a brief usage message
  48
  49 .\".SH USAGE
  50 .\".SH EXAMPLES
  51 .\".SH FILES
  52 .\".SH ENVIRONMENT
  53 .\".SH DIAGNOSTICS
  54 .\".SH SECURITY
  55 .\".SH CONFORMING TO
  56 .\".SH NOTES
  57 .\".SH BUGS
  58
  59 .SH LICENSE
  60
  61 \fBssindex\fR is licensed under the terms of the General Public
  62 License (GPL), version 2 or 3. For information on this license look at the
  63 source code that came with the software or see the
  64 .URL "http://www.gnu.org" "GNU project page" .
  65
  66 .SH COPYRIGHT
  67
  68 The copyright on \fBssindex\fR and the \fBgnumeric\fR software and source
  69 code is held by the individual authors as is documented in the source code.
  70
  71 .SH AUTHOR
  72
  73 \fBssindex\fR's primary author is Jody Goldberg <jody@gnome.org>;
  74 \fBssindex\fR builds on the \fBgnumeric\fR codebase.
  75
  76 The initial version of this manpage was written by J.H.M. Dassen (Ray)
  77 <jdassen@debian.org>.
  78
  79 .SH SEE ALSO
  80 \fBbeagled\fR(1),
  81 \fBgnumeric\fR(1),
  82 \fBssconvert\fR(1),
  83 \fBssdiff\fR(1)
  84 \fBssgrep\fR(1)
  85
  86 .URL "http://www.gnome.org/projects/gnumeric/" "The Gnumeric Homepage" .
  87
  88 .URL "http://www.gnome.org/" "The GNOME project page" .