doc/ssgrep.1

   1 .de URL
   2 \\$2 \(laURL: \\$1 \(ra\\$3
   3 ..
   4 .if \n[.g] .mso www.tmac
   5 .TH SSGREP 1 "2009-02-08" gnumeric "GNOME"
   6 .SH NAME
   7 ssgrep \- search spreadsheets for strings
   8
   9 .SH SYNOPSIS
  10 \fBssgrep \fR [\fIOPTIONS\fR] [\fIFILES\fR]
  11
  12 .SH DESCRIPTION
  13 This manual page briefly documents the \fBssgrep\fR command.
  14
  15 \fBssgrep\fR is a command line utility to search for strings in spreadsheets of
  16 any format supported by gnumeric. Without any output modifying options,
  17 \fBssgrep\fR prints one line for each match. A match consists of the matching
  18 content of a cell or, if the \fB\-R\fR option is given, the matching expression
  19 result of a cell.
  20
  21 .\".SH "RETURN VALUE"
  22 .\".SH "EXIT STATUS"
  23 .\".SH ERRORS
  24 .SH OPTIONS
  25 This program follows the usual GNU command line syntax, with single
  26 letter options starting with a single dash (`-') and longer options
  27 starting with two dashes (`--').
  28
  29 .SS "Options controlling input file handling"
  30 .TP
  31 .B \-\-recalc
  32 Recalculate all cells
  33
  34 .SS "Options controlling patterns and pattern matching"
  35 .TP
  36 .B \-f, \-\-keyword\-file=\fIFILE\fR
  37 The path to a text file containing one key per line
  38 .TP
  39 .B \-i, \-\-ignore\-case
  40 Ignore differences in letter case
  41 .TP
  42 .B \-w, \-\-word\-regexp
  43 Match only whole words
  44 .TP
  45 .B \-F, \-\-fixed\-strings
  46 Pattern is a set of fixed strings
  47 .TP
  48 .B \-R, \-\-search\-results
  49 Search results of expressions too
  50 .TP
  51 .B \-v, \-\-invert-match
  52 Search for cells that do not match
  53
  54 .SS "Options controlling output in general"
  55 .TP
  56 .B \-c, \-\-count
  57 Only print a count of matches per file
  58 .TP
  59 .B \-L, \-\-files\-without\-matches
  60 Print filenames without matches
  61 .TP
  62 .B \-l, \-\-files\-with\-matches
  63 Print filenames with matches
  64 .TP
  65 .B \-q, \-\-quiet
  66 Suppress all normal output
  67 .TP
  68 .B \-H, \-\-with\-filename
  69 Print the filename for each match
  70 .TP
  71 .B \-h, \-\-without\-filename
  72 Do not print the filename for each match
  73 .TP
  74 .B \-n, \-\-print\-locus
  75 Print the location of each match
  76 .TP
  77 .B \-T, \-\-print\-type
  78 Print the location type of each match
  79
  80 .SS "Help options"
  81 .TP
  82 .B \-V, \-\-version
  83 Display ssgrep's version
  84 .TP
  85 .B \-?, \-\-help
  86 Display the supported options
  87 .TP
  88 .B \-\-usage
  89 Display a brief usage message
  90
  91 .\".SH USAGE
  92 .SH EXAMPLE
  93 To search for the string "SUM" in the file \fIfoo.gnumeric\fR :
  94 .PP
  95 \fBssgrep\fR \fISUM\fR \fIfoo.gnumeric\fR
  96 .PP
  97 To search for the strings from the file \fIkeywords\fR in the spreadsheet \fIfoo.xls\fR :
  98 .PP
  99 \fBssgrep\fR \fB\-\-keyword\-file=\fIkeywords\fR \fIfoo.xls\fR
 100 .PP
 101
 102 .\".SH FILES
 103 .\".SH ENVIRONMENT
 104 .\".SH DIAGNOSTICS
 105 .\".SH SECURITY
 106 .\".SH CONFORMING TO
 107 .\".SH NOTES
 108 .\".SH BUGS
 109
 110 .SH LICENSE
 111
 112 \fBssgrep\fR is licensed under the terms of the General Public
 113 License (GPL), version 2 or 3. For information on this license look at the
 114 source code that came with the software or see the
 115 .URL "http://www.gnu.org" "GNU project page" .
 116
 117 .SH COPYRIGHT
 118
 119 The copyright on \fBssgrep\fR and the \fBgnumeric\fR software and source
 120 code is held by the individual authors as is documented in the source code.
 121
 122 .SH AUTHOR
 123
 124 \fBssgrep\fR's primary author is Jody Goldberg <jody@gnome.org>;
 125 \fBssgrep\fR builds on the \fBgnumeric\fR codebase.
 126
 127 The initial version of this manpage was based on ssindex.1 by J.H.M. Dassen
 128 (Ray) <jdassen@debian.org>.
 129
 130 .SH SEE ALSO
 131 \fBbeagled\fR(1),
 132 \fBgnumeric\fR(1),
 133 \fBssconvert\fR(1),
 134 \fBssdiff\fR(1)
 135 \fBssindex\fR(1)
 136
 137 .URL "http://www.gnome.org/projects/gnumeric/" "The Gnumeric Homepage" .
 138
 139 .URL "http://www.gnome.org/" "The GNOME project page" .