Post-release bump
[gnumeric.git] / doc / gnumeric.1
blobaa853e06fd54c75fa5bf035d7598424346bc9e1d
1 .de URL
2 \\$2 \(laURL: \\$1 \(ra\\$3
3 ..
4 .if \n[.g] .mso www.tmac
5 .TH GNUMERIC 1 "2009-02-08" gnumeric "GNOME"
6 .SH NAME
7 gnumeric \- a GNOME spreadsheet application.
9 .SH SYNOPSIS
10 \fBgnumeric\fR [\fIOPTIONS\fR] [\fIfiles\fR \fI...\fR ]
12 .SH DESCRIPTION
13 \fBGnumeric\fR is a powerful spreadsheet program created by the GNOME
14 project. \fBGnumeric\fR intends to compete with commercial
15 spreadsheets by becoming fully compatible with Microsoft Excel(TM) and
16 through the support of most popular spreadsheet file formats such as
17 Excel(TM), Lotus 1-2-3(TM), Applix(TM), Sylk(TM), XBase(TM),
18 Oleo(TM) and OpenOffice.org formats.
20 \fBGnumeric\fR supports advanced calculations using statistical,
21 financial and database access functions. Plotting data is supported
22 through an incomplete but powerful plotting system. A plugin system
23 extends \fBgnumeric\fR , for instance enabling the export of data to
24 the LaTeX \\longtable format. Plugins can be used to define custom
25 functionality. A rudimentary scripting API for the Python language
26 exists and will be extended in the near future. Since \fBgnumeric\fR
27 is \fBfree\fR software, \fBgnumeric\fR can also be extended directly
28 at the source code level by any competent programmer.
30 The program can be started from the command line as \fBgnumeric\fR or
31 from one of the menus provided by the underlying platform. When started
32 on the command line, \fBgnumeric\fR may be followed by the options listed
33 below and possibly the names of files in various spreadsheet formats
34 which will then be opened immediately. For instance, the command:
36     gnumeric myfile.gnumeric
38 will launch \fBgnumeric\fR and open the file called
39 "myfile.gnumeric". The default \fBgnumeric\fR file format is in
40 extensible markup language (XML) which subsequently has been
41 compressed with \fBgzip\fR.
43 .SH USER OPTIONS
44 This program follows the usual GNU command line syntax, with single
45 letter options starting with a single dash (`-') and longer options
46 starting with two dashes (`--').
48 .SS "Help options"
49 .B \-?, \-\-help
50 Show help message.
51 .TP
52 .B \-\-usage
53 Displays a brief usage message.
55 .SS "Gnumeric options"
56 .TP
57 .B \-v, \-\-version
58 Displays the version number of the installed instance of
59 \fBgnumeric\fR.
60 .TP
61 .B \-\-no-splash
62 Start \fBgnumeric\fR without showing the splash screen.  The splash 
63 screen is normally shown if loading files takes too long.
64 .TP
65 \fB\-L, \-\-lib-dir=\fR\fISTRING\fR 
66 Set the root library directory to STRING which should be a pathname.
67 .TP
68 \fB\-D, \-\-data-dir=\fR\fISTRING\fR 
69 Adjust the root data directory to STRING which should be a pathname.
71 .SS "Options for window placement"
72 .TP
73 \fB\-g, \-\-geometry=WIDTHxHEIGHT+XOFF+YOFF 
74 Set the size and position of the first window. All units are in
75 pixels. The X offset is from the left hand side of the screen, the Y
76 offset is from the top of the screen. For example, \-g=800x600+20+30
77 will open a gnumeric window 800 pixels wide by 600 pixels high, with
78 the left edge of gnumeric 20 pixels from the left of the screen and
79 the top edge of gnumeric 30 pixels from the top of the screen.
80 .TP
81 .B \fB\-\-display=\fR\fIDISPLAY\fR
82 X display to use, where DISPLAY has the form
83 machinename:Xdisplay.Screen. Note that the machine displaying gnumeric
84 must have granted the machine running gnumeric the right to display
85 (see xhost).
87 .TP 
88 .B \fB\-\-screen=\fR\fISCREEN\fR
89 X screen to use, a more compact form of the functionality described
90 above.
95 .SH ADVANCED OPTIONS
97 .SS "GNOME options"
98 .TP
99 .B \-\-disable-sound
100 Disable sound server usage.
102 .B \-\-enable-sound
103 Enable sound server usage.
105 \fB\-\-espeaker=\fR\fIHOSTNAME:PORT\fR
106 Host:port on which the sound server to use is running.
108 .B \-\-disable-crash-dialog
109 Disable the bug submission dialog which appears if Gnumeric crashes.
111 .SS "GTK options"
113 \fB\-\-gdk-debug=\fR\fIFLAGS\fR
114 Gdk debugging flags to set.
116 \fB\-\-gdk-no-debug=\fR\fIFLAGS\fR
117 Gdk debugging flags to unset.
119 .B \-\-sync
120 Make X calls synchronous.
122 \fB\-\-name=\fR\fINAME\fR
123 Program name as used by the window manager.
125 \fB\-\-class=\fR\fICLASS\fR
126 Program class as used by the window manager.
128 \fB\-\-gxid_host=\fR\fIHOST\fR
129 The host on which to contact the gxid daemon. This overrides the GXID_HOST environment variable. This option is only available if GTK+ has been configured with \-\-gdk-target=x11.
131 \fB\-\-gxid_port=\fR\fIPORT\fR
132 The port for the connection to gxid. This overrides the GXID_PORT environment variable. This option is only available if GTK+ has been configured with \-\-gdk-target=x11.
134 \fB\-\-gtk-debug=\fR\fIFLAGS\fR
135 Gtk+ debugging flags to set.
137 \fB\-\-gtk-no-debug=\fR\fIFLAGS\fR
138 Gtk+ debugging flags to unset.
140 \fB\-\-g-fatal-warnings\fR
141 Make all warnings fatal.
143 \fB\-\-gtk-module=\fR\fIMODULE\fR
144 Load an additional Gtk module.
146 .SS "Session management options"
148 \fB\-\-sm-client-id=\fR\fIID\fR
149 Specify session management ID.
151 \fB\-\-sm-config-prefix=\fR\fIPREFIX\fR
152 Specify prefix of saved configuration.
154 .B \-\-sm-disable
155 Disable connection to session manager.
158 .SH VERSION
159 This manual page describes \fBgnumeric\fR version 1.8.
161 .SH BUGS
162 For the list of known \fBgnumeric\fR bugs, or to report new ones
163 please visit \fIhttp://bugzilla.gnome.org\fR.
165 .SH "SEE ALSO"
166 \fBssconvert\fR(1),
167 \fBssindex\fR(1),
168 \fBssdiff\fR(1)
169 \fBssgrep\fR(1)
171 .B The Gnumeric Manual
172 Available through the \fBHelp\fR menu or 
173 .URL "http://www.gnome.org/projects/gnumeric/doc/gnumeric.shtml" online .
175 .URL "http://www.gnome.org/projects/gnumeric/" "The Gnumeric Homepage" .
177 .URL "http://www.gnome.org/" "The GNOME project page" .
179 .SH LICENSE
181 \fBGnumeric\fR is licensed under the terms of the General Public
182 License (GPL), version 2 or 3. For information on this license look at the
183 source code that came with the software or see the 
184 .URL "http://www.gnu.org/" "GNU project page" .
186 .SH COPYRIGHT
188 The copyright on the \fBgnumeric\fR software and source code is held
189 by the individual authors as is documented in the source code.
192 .SH AUTHORS
193 .SS "Gnumeric"
194 Jody Goldberg <jody@gnome.org>
196 Miguel de Icaza <miguel@gnome.org>
198 Morten Welinder <terra@gnome.org>
201 -- and many others.  For a more complete list, see the About dialog.
202 .SS "This manual page"
203 Jan Schaumann <jschauma@netmeister.org>
205 Adrian Custer <acuster@gnome.org>