.\"
.\" tbl lyx.1 | nroff -man | less
.\"
-.TH LYX 1 "November 1999" "Version 1.1" "LyX 1.1"
+.TH LYX 1 "Jan 2003" "Version 1.3" "LyX 1.3"
.SH NAME
lyx \- A Document Processor
.\"
.el \(co
..
.SH SYNOPSIS
-\fBlyx\fR [ \fIcommand-line switches\fR] [\fIname.lyx ...\fR ]
+\fBlyx\fR [ \fIcommand-line switches\fR ] [ \fIname[.lyx] ...\fR ]
.br
.SH DESCRIPTION
\fBLyX\fR is too complex to be described completely in the "man" page
format. If your system is properly configured, you can access the full
documentation within \fBLyX\fR under the Help menu.
-\fBLyX\fR is a modern approach of writing documents with a computer
-which breaks with the tradition of the obsolete typewriter concept. It
-is designed for people who want a professional output with a minimum
-of time effort, without becoming specialists in typesetting. Compared
-to common word processors, \fBLyX\fR will increase the productivity a
-lot, since most of the typesetting will be done by the computer, not
-the author. With \fBLyX\fR the author can concentrate on the contents
-of his writing, since the computer will take care of the look. Read more
-about this concept in the online documentation under the Help menu.
-
-Currently, \fBLyX\fR uses the XForms library as a toolkit. \fBLyX\fR
-should run everywhere, where XForms runs. This is on all major Unix
-platforms as well as some PC platforms, including Sun, SGI, HP, DEC
-Alpha/OSF, IBM RS6000, Convex, Cray, i386/Linux, Alpha/Linux,
-i386/FreeBSD, i386/NetBSD, DecSystem(mips)/Ultrix, OS/2 with XFree or
-PMX and others.
+\fBLyX\fR is a document preparation system. It excels at letting you
+create complex technical and scientific articles with mathematics,
+cross-references, bibliographies, indices, etc. It is very good at
+documents of any length in which the usual processing abilities are
+required: automatic sectioning and pagination, spellchecking, and so
+forth. It can also be used to write a letter to your mom, though
+granted, there are probably simpler programs available for that. It is
+definitely not the best tool for creating banners, flyers, or
+advertisements, though with some effort all these can be done, too.
+Some examples of what it is used for: memos, letters, dissertations
+and theses, lecture notes, seminar notebooks, conference proceedings,
+software documentation, books (on PostgreSQL, remote sensing,
+cryptology, fictional novels, poetry, and even a children's book or
+two), articles in refereed scientific journals, scripts for plays and
+movies, business proposals... you get the idea.
+Currently, \fBLyX\fR uses either the XForms or Qt library as a
+toolkit. \fBLyX\fR should run everywhere, where these libraries run.
+This is on all major Unix platforms as well as Windows, Mac OS X
+(which actually is a unix platform) and OS/2.
.SH OPTIONS
-\fBLyX\fR supports the following command-line switches, which can also
-be specified as X resources (e. g. in .Xdefaults) with class
-name \fBLyX\fR:
+\fBLyX\fR supports the following command-line switches.
.TP 6
.BI \-help
summarizes LyX usage
.TP
+.BI \-version
+provides version information on the build of LyX.
+.TP
.BI \-sysdir " directory"
sets system directory. Normally not needed.
.TP
-.BI \-width " x"
-the width of the main window in \fBLyX\fR.
-.TP
-.BI \-height " y"
-the height of the main window in \fBLyX\fR.
-.TP
-.BI \-xpos " x"
-the x position of the main window in \fBLyX\fR.
-.TP
-.BI \-ypos " y"
-the y position of the main window in \fBLyX\fR.
-Notice, you have to specify both
-.BI \-xpos
-and
-.BI \-ypos
-to obtain the
-desired effect. Negative positions are ignored. If no valid position
-is given, the main window is centered.
+.BI \-userdir " directory"
+sets user directory. Needed if you want to use LyX with different lyxrc
+settings.
.TP
.BI \-dbg " feature[,feature...]"
where feature is a name or number.
Use "\fBlyx -dbg\fR" to see the list of available debug features.
.TP
-.BI \-Reverse
-swaps foreground and background colors.
-.TP
-.BI \-Mono
-runs \fBLyX\fR in black and white mode.
-.TP
-.BI \-FastSelection
-uses a fast black and white drawing routine for selections. If you use
-this, the switches BackgroundColor and SelectionColor are ignored.
-.PP
-The following options can be used to define the colors to use for
-different things:
-.TP
-.BI \-MathColor " color"
-.TP
-.BI \-MathFrameColor " color"
-.TP
-.BI \-FootColor " color"
-.TP
-.BI \-LabelColor " color"
-.TP
-.BI \-FillColor " color"
-.TP
-.BI \-NewLineColor " color"
-.TP
-.BI \-OnOffLineColor " color"
-.TP
-.BI \-LatexColor " color"
-.TP
-.BI \-NoteColor " color"
+\fB -x [--execute]\fP \fIcommand
+where command is a lyx command.
.TP
-.BI \-LightedColor " color"
+\fB -e [--export]\fP \fIfmt
+where fmt is the export format of choice.
.TP
-.BI \-BackgroundColor " color"
-.TP
-.BI \-SelectionColor " color"
-.PP
-Furthermore, \fBLyX\fR understands the following generic command line options
-from the \fBForms Library\fR:
+\fB -i [--import]\fP \fIfmt file.xxx
+where fmt is the import format of choice and file.xxx is the file to be imported.
+
+.SH XFORMS FRONTEND OPTIONS
+When compiled with the XForms frontend, \fBLyX\fR understands the
+following generic command line options from the \fBForms Library\fR,
+which can also be specified as X resources (e. g. in .Xdefaults) with
+class name \fBLyX\fR.
.TP 6
+.BI \-geometry " WxH+X+Y"
+specifies the preferred size and position of the main \fBLyX\fR
+window; see \fIX(1)\fR.
+.TP
.BI \-display " host:display"
specifies the server to connect to.
.TP
.BI \-bw " borderwidth"
-specifies the border width to use to built-in objects.
+specifies the border width to use to built-in objects.
.TP
.BI \-visual " visualName"
requests a visual by name such as TrueColor etc. By default the
.TP
.BI \-debug " level"
generates some info about the state of the
-.B XForms.
-where
+.B XForms.
+where
.I level
is an integer between 1-5 and controls the amount of
information to output. Depending on the options used
was built, a level more than 3 might not be available.
.TP
.B \-sync
-runs the application in synchronous mode with debug level set to 4.
+runs the application in synchronous mode with debug level set to 4.
.TP
.B \-private
requests a private colormap for the application.
.TP
.B \-name " newname"
specifies the application name under which resources are to be
-obtained, rather than the default executable file name.
+obtained, rather than the default executable file name.
.SH ENVIRONMENT
.TP
-.B LYX_DIR_11x
+.B LYX_DIR_13x
can be used to specify which system directory to use.
.PP
The system directory is determined by searching for the file
.br
1) -sysdir command line parameter
.br
-2) LYX_DIR_11x environment variable
+2) LYX_DIR_13x environment variable
.br
3) Maybe <path of binary>/TOP_SRCDIR/lib
.br
-4) <path of binary>/../share/<name of binary>/
+4) <path of binary>/../share/<name of binary>/
.br
5) hardcoded lyx_dir (usually /usr/local/share/lyx on UNIX and %X11ROOT%\\XFree86\\lib\\X11\\lyx on OS/2 with XFree)
+.TP
+.B LYX_USERDIR_13x
+can be used to specify which user directory to use.
+.PP
+The user directory is, in order of precedence:
+.br
+1) -userdir command line parameter
+.br
+2) LYX_USERDIR_13x environment variable
+.br
+3) $HOME/.<name of binary> if no explicit setting is made
.TP
.B LYX_LOCALEDIR
can be used to tell LyX where to look for the translations of its GUI
strings in other languages.
-
.SH FILES
.nf
.ta \w'\fILIBDIR\fR/lyxrc.in 'u
-~/.lyx/lyxrc Personal configuration file
+~/.lyx/preferences Personal configuration file
+~/.lyx/lyxrc.defaults Personal autodetected configuration file
\fILIBDIR\fR/lyxrc System wide configuration file
-\fILIBDIR\fR/lyxrc.example System wide configuration file template
+\fILIBDIR\fR/lyxrc.defaults System wide autodetected configuration file
\fILIBDIR\fR/configure Updates \fBLyX\fR if config has changed
\fILIBDIR\fR/bind/ Keybindings
\fILIBDIR\fR/clipart/ Clipart pictures
.I LIBDIR
is the system directory. This is usually /usr/local/share/lyx on UNIX and %X11ROOT%\\XFree86\\lib\\X11\\lyx on OS/2 with XFree.
-
.SH SEE ALSO
reLyX(1), latex(1), xforms(5).
Full documentation in either native \fBLyX\fR or postscript format.
.SH BUGS/LIMITATIONS
-There are probably still some bugs in \fBLyX\fR. Please report them to
-lyx-devel@lists.lyx.org with detailed info, including which version of \fBLyX\fR
-you use. Consult the "Known Bugs" item under the Help menu first if possible.
-
-\fBLaTeX\fR import is still not perfect and may produce buggy *.lyx files. Consult the \fBreLyX\fR documentation.
-
-XFree on OS/2 currently does not support PC codepages. If you use \fBemTeX\fR to preview/print with cp850, etc., this might lead to strange \fBemTeX\fR error messages.
-.B Remedy:
- 1) In filenames use only A-Z, a-z, 1-9.
- 2) Install a recent \fBLaTeX\fR package inputenc.sty. Select Layout->Document->encoding:latin1, so that \fBreLyX\fR adds the \fBLaTeX\fR command '\\usepackage[latin1]{inputenc}'.
-
-\fBLyX\fR server has some limitations under OS/2: See Help->Customization for details.
-
-Preview of inline images in rare cases does not show the image. If you want to preview the image, just click on it and choose fullscreen preview.
-
-If you have performance problems, please go through the \fBlyxrc\fR
-configuration file. It contains settings that can be used to improve
-performance on slow systems.
-
+There are still some bugs in \fBLyX\fR. To report one, read if
+possible the Introduction found under the Help menu in LyX. You'll
+find detailed info on submitting bug reports there. If you can't do
+that, send details to the LyX Developers mailing list
+lyx-devel@lists.lyx.org, or use the LyX bug tracker at
+http://bugzilla.lyx.org/. Don't forget to mention which version you
+are having problems with!
+\fBLaTeX\fR import is still not perfect and may produce buggy *.lyx
+files. Consult the \fBreLyX\fR documentation.
-.SH AUTHOR
+.SH AUTHORS
Copyright
.Cr
-1995, 1996, 1997, 1998, 1999 by Matthias Ettrich (ettrich@informatik.uni-tuebingen.de)
-and the rest of the \fBLyX Team\fR (See Credits under the Help menu
-item).
+1995, 1996, 1997, 1998, 1999, 2000, 2001, 2002 by Matthias Ettrich
+(ettrich@informatik.uni-tuebingen.de) and the rest of the \fBLyX
+Team\fR (See About LyX under the Help menu item).
projects / lyx.git / blobdiff