X-Git-Url: https://git.lyx.org/gitweb/?a=blobdiff_plain;f=lyx.man;h=f2be174c4be8f9f0bc645e6ac349ee055c4f001f;hb=6f8c2a51f5ef44f01abbcd8a90b03f4d1c1933de;hp=12900db1f6bfc21ffd6e56f3603fcfd347625424;hpb=8fd9e5de46b162d2f507270a8338d643bae66e7b;p=lyx.git diff --git a/lyx.man b/lyx.man index 12900db1f6..f2be174c4b 100644 --- a/lyx.man +++ b/lyx.man @@ -3,7 +3,7 @@ .\" .\" tbl lyx.1 | nroff -man | less .\" -.TH LYX 1 "May 2002" "Version 1.3" "LyX 1.3" +.TH LYX 1 "Jan 2003" "Version 1.4" "LyX 1.4" .SH NAME lyx \- A Document Processor .\" @@ -13,37 +13,35 @@ 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 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 +\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 (we'll explain why later), 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. +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 the XForms library as a toolkit. \fBLyX\fR -should run everywhere, where XForms runs. This is on all major Unix -platforms as well as Windows, Mac OS X (which actually is a unix -platform) and OS/2. +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 and Mac OS X +(which actually is a unix platform). .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 @@ -55,34 +53,37 @@ provides version information on the build of LyX. sets system directory. Normally not needed. .TP .BI \-userdir " directory" -sets user directory. Needed if you want to use LyX with different lyxrc +sets user directory. Needed if you want to use LyX with different lyxrc settings. .TP -.BI \-geometry " WxH+X+Y" -specifies the preferred size and position of the main \fBLyX\fR window; see \fIX(1)\fR. -.TP .BI \-dbg " feature[,feature...]" where feature is a name or number. -Use "\fBlyx -dbg\fR" to see the list of available debug features. +Use "\fBlyx \-dbg\fR" to see the list of available debug features. .TP -\fB -x [--execute]\fP \fIcommand +\fB \-x [\-\-execute]\fP \fIcommand where command is a lyx command. .TP -\fB -e [--export]\fP \fIfmt +\fB \-e [\-\-export]\fP \fIfmt where fmt is the export format of choice. .TP -\fB -i [--import]\fP \fIfmt file.xxx +\fB \-i [\-\-import]\fP \fIfmt file.xxx where fmt is the import format of choice and file.xxx is the file to be imported. -.PP -Furthermore, \fBLyX\fR understands the following generic command line options -from the \fBForms Library\fR: +.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 @@ -90,22 +91,22 @@ requests a visual by name such as TrueColor etc. By default the always selects the visual that has the most depth. .TP .BI \-depth " depth" -requests a specific depth. Try "\fB-depth\fR best" or "\fB-depth\fR +requests a specific depth. Try "\fB\-depth\fR best" or "\fB\-depth\fR 8" if you get a bad match. .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 +is an integer between 1\-5 and controls the amount of information to output. Depending on the options used when the .B Forms Library 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. @@ -121,33 +122,33 @@ requests a standard colormap. .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_13x +.B LYX_DIR_15x can be used to specify which system directory to use. .PP The system directory is determined by searching for the file "chkconfig.ltx". Directories are searched in this order: .br -1) -sysdir command line parameter +1) \-sysdir command line parameter .br -2) LYX_DIR_13x environment variable +2) LYX_DIR_15x environment variable .br 3) Maybe /TOP_SRCDIR/lib .br -4) /../share// +4) /../share// .br -5) hardcoded lyx_dir (usually /usr/local/share/lyx on UNIX and %X11ROOT%\\XFree86\\lib\\X11\\lyx on OS/2 with XFree) +5) hardcoded lyx_dir (usually /usr/local/share/lyx on UNIX) .TP -.B LYX_USERDIR_13x +.B LYX_USERDIR_15x can be used to specify which user directory to use. .PP -The user directory is, in order of precedence: +The user directory is, in order of precedence: .br -1) -userdir command line parameter +1) \-userdir command line parameter .br -2) LYX_USERDIR_13x environment variable +2) LYX_USERDIR_15x environment variable .br 3) $HOME/. if no explicit setting is made @@ -158,9 +159,10 @@ 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 @@ -175,9 +177,9 @@ strings in other languages. .fi .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. +is the system directory. This is usually /usr/local/share/lyx on UNIX. .SH SEE ALSO -reLyX(1), latex(1), xforms(5). +tex2lyx(1), latex(1). Full documentation in either native \fBLyX\fR or postscript format. .SH BUGS/LIMITATIONS @@ -185,33 +187,16 @@ 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 +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. - -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. +files. Consult the \fBtex2lyx\fR documentation. -If you have performance problems, please go through the -Edit>Preferences... dialog. It contains settings that can be used to -improve performance on slow systems. .SH AUTHORS -Copyright +Copyright .Cr 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 Credits under the Help menu item). +(ettrich@informatik.uni\-tuebingen.de) and the rest of the \fBLyX +Team\fR (See About LyX under the Help menu item).