lyx.man

   1 .\" Man page for LyX.
   2 .\" Use the following command to view man page:
   3 .\"
   4 .\"  tbl lyx.1 | nroff -man | less
   5 .\"
   6 .TH LYX 1 "November 1999" "Version 1.1" "LyX 1.1"
   7 .SH NAME
   8 lyx \- A Document Processor
   9 .\"
  10 .\" setup
  11 .de Cr
  12 .ie n (c)
  13 .el \(co
  14 ..
  15 .SH SYNOPSIS
  16 \fBlyx\fR [ \fIcommand-line switches\fR] [\fIname.lyx ...\fR ]
  17 .br
  18 .SH DESCRIPTION
  19 \fBLyX\fR is too complex to be described completely in the "man" page
  20 format. If your system is properly configured, you can access the full
  21 documentation within \fBLyX\fR under the Help menu.
  22
  23 \fBLyX\fR is a modern approach of writing documents with a computer
  24 which breaks with the tradition of the obsolete typewriter concept. It
  25 is designed for people who want a professional output with a minimum
  26 of time effort, without becoming specialists in typesetting. Compared
  27 to common word processors, \fBLyX\fR will increase the productivity a
  28 lot, since most of the typesetting will be done by the computer, not
  29 the author. With \fBLyX\fR the author can concentrate on the contents
  30 of his writing, since the computer will take care of the look. Read more
  31 about this concept in the online documentation under the Help menu.
  32
  33 Currently, \fBLyX\fR uses the XForms library as a toolkit. \fBLyX\fR
  34 should run everywhere, where XForms runs. This is on all major Unix
  35 platforms as well as some PC platforms, including Sun, SGI, HP, Compaq
  36 Tru64, IBM RS6000, Convex, Cray, i386/Linux, Alpha/Linux,
  37 i386/FreeBSD, i386/NetBSD, DecSystem(mips)/Ultrix, OS/2 with XFree or
  38 PMX and others.
  39 .SH OPTIONS
  40 \fBLyX\fR supports the following command-line switches, which can also
  41 be specified as X resources (e. g. in .Xdefaults) with class
  42 name \fBLyX\fR:
  43 .TP 6
  44 .BI \-help
  45 summarizes LyX usage
  46 .TP
  47 .BI \-sysdir " directory"
  48 sets system directory. Normally not needed.
  49 .TP
  50 .BI \-userdir " directory"
  51 sets user directory. Needed if you want to use LyX with different lyxrc
  52 settings.
  53 .TP
  54 .BI \-geometry " WxH+X+Y"
  55 specifies the preferred size and position of the main \fBLyX\fR window; see \fIX(1)\fR.
  56 .TP
  57 .BI \-dbg " feature[,feature...]"
  58 where feature is a name or number.
  59 Use "\fBlyx -dbg\fR" to see the list of available debug features.
  60 .PP
  61 Furthermore, \fBLyX\fR understands the following generic command line options
  62 from the \fBForms Library\fR:
  63 .TP 6
  64 .BI \-display " host:display"
  65 specifies the server to connect to.
  66 .TP
  67 .BI \-bw " borderwidth"
  68 specifies the border width to use to built-in objects.
  69 .TP
  70 .BI \-visual " visualName"
  71 requests a visual by name such as TrueColor etc. By default the
  72 .B Forms Library
  73 always selects the visual that has the most depth.
  74 .TP
  75 .BI \-depth " depth"
  76 requests a specific depth. Try "\fB-depth\fR best" or "\fB-depth\fR
  77 8" if you get a bad match.
  78 .TP
  79 .BI \-debug " level"
  80 generates some info about the state of the
  81 .B XForms.
  82 where
  83 .I level
  84 is an integer between 1-5 and controls the amount of
  85 information to output. Depending on the options used
  86 when the
  87 .B Forms Library
  88 was built, a level more than 3 might not be available.
  89 .TP
  90 .B \-sync
  91 runs the application in synchronous mode with debug level set to 4.
  92 .TP
  93 .B \-private
  94 requests a private colormap for the application.
  95 .TP
  96 .B \-shared
  97 requests a shared colormap even if the application needs more
  98 colors than available. For those colors that can't be allocated
  99 in the shared colormap, substitutions are made so the closest
 100 matching color is used.
 101 .TP
 102 .B \-stdcmap
 103 requests a standard colormap.
 104 .TP
 105 .B \-name " newname"
 106 specifies the application name under which resources are to be
 107 obtained, rather than the default executable file name.
 108 .SH ENVIRONMENT
 109 .TP
 110 .B LYX_DIR_11x
 111 can be used to specify which system directory to use.
 112 .PP
 113 The system directory is determined by searching for the file
 114 "chkconfig.ltx". Directories are searched in this order:
 115 .br
 116 1) -sysdir command line parameter
 117 .br
 118 2) LYX_DIR_11x environment variable
 119 .br
 120 3) Maybe <path of binary>/TOP_SRCDIR/lib
 121 .br
 122 4) <path of binary>/../share/<name of binary>/
 123 .br
 124 5) hardcoded lyx_dir (usually /usr/local/share/lyx on UNIX and %X11ROOT%\\XFree86\\lib\\X11\\lyx on OS/2 with XFree)
 125 .TP
 126 .B LYX_USERDIR_11x
 127 can be used to specify which user directory to use.
 128 .PP
 129 The user directory is, in order of precedence:
 130 .br
 131 1) -userdir command line parameter
 132 .br
 133 2) LYX_USERDIR_11x environment variable
 134 .br
 135 3) $HOME/.<name of binary> if no explicit setting is made
 136
 137 .TP
 138 .B LYX_LOCALEDIR
 139 can be used to tell LyX where to look for the translations of its GUI
 140 strings in other languages.
 141 .SH FILES
 142 .nf
 143 .ta \w'\fILIBDIR\fR/lyxrc.in  'u
 144 ~/.lyx/lyxrc      Personal configuration file
 145 \fILIBDIR\fR/lyxrc      System wide configuration file
 146 \fILIBDIR\fR/lyxrc.example System wide configuration file template
 147 \fILIBDIR\fR/configure  Updates \fBLyX\fR if config has changed
 148 \fILIBDIR\fR/bind/      Keybindings
 149 \fILIBDIR\fR/clipart/   Clipart pictures
 150 \fILIBDIR\fR/doc/       Documentation in \fBLyX\fR format.
 151 \fILIBDIR\fR/examples/  Example documents
 152 \fILIBDIR\fR/images/    Images used as icons or in popups
 153 \fILIBDIR\fR/kbd/       Keyboard mappings
 154 \fILIBDIR\fR/layouts/   Layout descriptions
 155 \fILIBDIR\fR/templates/ Templates for documents
 156 \fILIBDIR\fR/tex/       Extra TeX files
 157 .Sp
 158 .fi
 159
 160 .I LIBDIR
 161 is the system directory. This is usually /usr/local/share/lyx on UNIX and %X11ROOT%\\XFree86\\lib\\X11\\lyx on OS/2 with XFree.
 162 .SH SEE ALSO
 163 reLyX(1), latex(1), xforms(5).
 164
 165 Full documentation in either native \fBLyX\fR or postscript format.
 166 .SH BUGS/LIMITATIONS
 167 There are probably still some bugs in \fBLyX\fR. Please report them to
 168 lyx-devel@lists.lyx.org with detailed info, including which version of
 169 \fBLyX\fR you use. Consult the "Known Bugs" item under the Help menu
 170 first if possible.
 171
 172 \fBLaTeX\fR import is still not perfect and may produce buggy *.lyx
 173 files. Consult the \fBreLyX\fR documentation.
 174
 175 XFree on OS/2 currently does not support PC codepages. If you use
 176 \fBemTeX\fR to preview/print with cp850, etc., this might lead to
 177 strange \fBemTeX\fR error messages.
 178 .B Remedy:
 179   1) In filenames use only A-Z, a-z, 1-9.
 180   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}'.
 181
 182 \fBLyX\fR server has some limitations under OS/2: See
 183 Help->Customization for details.
 184
 185 Preview of inline images in rare cases does not show the image. If you
 186 want to preview the image, just click on it and choose fullscreen
 187 preview.
 188
 189 If you have performance problems, please go through the \fBlyxrc\fR
 190 configuration file. It contains settings that can be used to improve
 191 performance on slow systems.
 192 .SH AUTHORS
 193 Copyright
 194 .Cr
 195 1995, 1996, 1997, 1998, 1999 by Matthias Ettrich
 196 (ettrich@informatik.uni-tuebingen.de) and the rest of the \fBLyX
 197 Team\fR (See Credits under the Help menu item).