X-Git-Url: https://git.lyx.org/gitweb/?a=blobdiff_plain;f=lyx.man;h=8ee7717438d06ab96a0d964ee2a2136e1f6aef9f;hb=615cc9ec4abb02cee89f064e6b85999fcd182706;hp=a58b05757a2d5ffa5336394bf27611e5f4c80802;hpb=27de1486ca34aaad446adb798d71a77d6f6304da;p=lyx.git diff --git a/lyx.man b/lyx.man index a58b05757a..8ee7717438 100644 --- a/lyx.man +++ b/lyx.man @@ -3,7 +3,7 @@ .\" .\" tbl lyx.1 | nroff -man | less .\" -.TH LYX 1 "October 1998" "Version 1.0" "LyX 1.0" +.TH LYX 1 "April 2002" "Version 1.2" "LyX 1.2" .SH NAME lyx \- A Document Processor .\" @@ -20,23 +20,26 @@ lyx \- A Document Processor 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. +\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. 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. - +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 @@ -45,68 +48,32 @@ name \fBLyX\fR: .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. -.TP -.BI \-dbg " debug-level" -where debug-level is a sum of debugging options. -Use "\fBlyx -dbg 65535 -help\fR" to see the different flags. -.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" +.BI \-userdir " directory" +sets user directory. Needed if you want to use LyX with different lyxrc +settings. .TP -.BI \-FillColor " color" +.BI \-geometry " WxH+X+Y" +specifies the preferred size and position of the main \fBLyX\fR window; see \fIX(1)\fR. .TP -.BI \-NewLineColor " color" +.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 \-OnOffLineColor " color" +\fB -x [--execute]\fP \fIcommand +where command is a lyx command. .TP -.BI \-LatexColor " color" +\fB -e [--export]\fP \fIfmt +where fmt is the export format of choice. .TP -.BI \-NoteColor " color" -.TP -.BI \-LightedColor " color" -.TP -.BI \-BackgroundColor " color" -.TP -.BI \-SelectionColor " color" +\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: @@ -157,7 +124,7 @@ specifies the application name under which resources are to be obtained, rather than the default executable file name. .SH ENVIRONMENT .TP -.B LYX_DIR_10x +.B LYX_DIR_12x can be used to specify which system directory to use. .PP The system directory is determined by searching for the file @@ -165,19 +132,29 @@ The system directory is determined by searching for the file .br 1) -sysdir command line parameter .br -2) LYX_DIR_10x environment variable +2) LYX_DIR_12x environment variable .br 3) Maybe /TOP_SRCDIR/lib .br 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) +.TP +.B LYX_USERDIR_12x +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_12x environment variable +.br +3) $HOME/. 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 @@ -199,37 +176,42 @@ strings in other languages. .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. +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. +\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. +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. - +\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. -.SH AUTHOR +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 .Cr -1995, 1996, 1997, 1998 by Matthias Ettrich (ettrich@informatik.uni-tuebingen.de) -and the rest of the \fBLyX Team\fR (See Credits under the Help menu -item). - \ No newline at end of file +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).