lyx.1in

   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 "@LYX_DATE@" "Version @VERSION@" "LyX @VERSION@"
   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@version_suffix@\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 document preparation system. It excels at letting you
  24 create complex technical and scientific articles with mathematics,
  25 cross\-references, bibliographies, indices, etc. It is very good at
  26 documents of any length in which the usual processing abilities are
  27 required: automatic sectioning and pagination, spellchecking, and so
  28 forth. It can also be used to write a letter to your mom, though
  29 granted, there are probably simpler programs available for that. It is
  30 definitely not the best tool for creating banners, flyers, or
  31 advertisements, though with some effort all these can be done, too.
  32 Some examples of what it is used for: memos, letters, dissertations
  33 and theses, lecture notes, seminar notebooks, conference proceedings,
  34 software documentation, books (on PostgreSQL, remote sensing,
  35 cryptology, fictional novels, poetry, and even a children's book or
  36 two), articles in refereed scientific journals, scripts for plays and
  37 movies, business proposals... you get the idea.
  38
  39 Currently, \fBLyX\fR uses the Qt4 library as a
  40 toolkit. \fBLyX\fR should run everywhere, where this library runs.
  41 This is on all major Unix platforms as well as Windows and Mac OS X
  42 (which actually is a unix platform).
  43 .SH OPTIONS
  44 \fBLyX\fR supports the following command\-line switches.
  45 .TP 6
  46 .BI \-help
  47 summarizes LyX usage
  48 .TP
  49 .BI \-version
  50 provides version information on the build of LyX.
  51 .TP
  52 .BI \-sysdir " directory"
  53 sets system directory. Normally not needed.
  54 .TP
  55 .BI \-userdir " directory"
  56 sets user directory. Needed if you want to use LyX with different lyxrc
  57 settings.
  58 .TP
  59 .BI \-geometry " WxH+X+Y"
  60 set geometry of the main window.
  61 .TP
  62 .BI \-dbg " feature[,feature...]"
  63 where feature is a name or number.
  64 Use "\fBlyx@version_suffix@ \-dbg\fR" to see the list of available debug features.
  65 .TP
  66 \fB \-x [\-\-execute]\fP \fIcommand
  67 where command is a lyx command.
  68 .TP
  69 \fB \-e [\-\-export]\fP \fIfmt
  70 where fmt is the export format of choice (latex, pdflatex, luatex, xetex, xhtml, text, lyx, ps, pdf, ...).
  71 Note that the order of \-e and \-x switches matters.
  72 .TP
  73 \fB \-E [\-\-export\-to]\fP \fIfmt \fIfilename
  74 where fmt is the export format of choice (see \-\-export), and filename is the destination filename. Note that any additional external file needed by filename (such as image files) will be exported as well to the folder containing filename (preserving the relative path embedded within the original LyX document, if any).
  75 .TP
  76 \fB \-i [\-\-import]\fP \fIfmt file.xxx
  77 where fmt is the import format of choice and file.xxx is the file to be imported.
  78 .TP
  79 \fB \-f [\-\-force\-overwrite]\fP \fIwhat
  80 where what is is either "\fBall\fR", "\fBmain\fR" or "\fBnone\fR".
  81 Specify "\fBall\fR" to allow overwriting all files during a batch export,
  82 "\fBmain\fR" to allow overwriting the main file only, or "\fBnone\fR"
  83 to disallow overwriting any file. When this switch is followed by anything
  84 else other than "\fBall\fR", "\fBmain\fR" or "\fBnone\fR", the behavior is as
  85 if "\fBall\fR" was specified, but what follows is left on the command line for
  86 further processing.
  87 .TP
  88 \fB \-\-ignore\-error\-message\fP \fIwhich
  89 allows you to ignore specific LaTeX error messages.
  90 Do not use for final documents! Currently supported values:
  91 "\fBmissing_glyphs\fR" Fontspec "missing glyphs" error.
  92 .TP
  93 \fB \-n [\-\-no\-remote]\fP
  94 open documents passed as arguments in a new instance, even if another
  95 instance of LyX is already running.
  96 .TP
  97 \fB \-r [\-\-remote]\fP
  98 by using the lyxpipe, ask an already running instance of LyX to open the
  99 documents passed as arguments and then exit. If the lyxpipe is not set up or
 100 is not working, a new instance is created and execution continues normally.
 101 .TP
 102 \fB \-v [\-\-verbose]\fP
 103 print on terminal all spawned external commands.
 104 .TP
 105 .BI \-batch
 106 causes LyX to run the given commands without opening a GUI window.
 107 Thus, something like:
 108 .br
 109     lyx \-batch \-x "buffer\-print printer default dvips" myfile.lyx
 110 .br
 111 will cause LyX to print myfile.lyx to the default printer, using dvips and
 112 the default print settings (which, of course, have to have been configured
 113 already).
 114
 115 .SH ENVIRONMENT
 116 .TP
 117 .B @LYX_DIR_VER@
 118 can be used to specify which system directory to use.
 119 .PP
 120 The system directory is determined by searching for the file
 121 "chkconfig.ltx". Directories are searched in this order:
 122 .br
 123 1) \-sysdir command line parameter
 124 .br
 125 2) @LYX_DIR_VER@ environment variable
 126 .br
 127 3) Maybe <path of binary>/TOP_SRCDIR/lib
 128 .br
 129 4) <path of binary>/../share/<name of binary>/
 130 .br
 131 5) hardcoded lyx_dir (at build time: @real_pkgdatadir@)
 132 .TP
 133 .B @LYX_USERDIR_VER@
 134 can be used to specify which user directory to use.
 135 .PP
 136 The user directory is, in order of precedence:
 137 .br
 138 1) \-userdir command line parameter
 139 .br
 140 2) @LYX_USERDIR_VER@ environment variable
 141 .br
 142 3) $HOME/.<name of binary> if no explicit setting is made
 143
 144 .TP
 145 .B LYX_LOCALEDIR
 146 can be used to tell LyX where to look for the translations of its GUI
 147 strings in other languages.
 148
 149 .TP
 150 .B LYX_FORCE_OVERWRITE
 151 can be used to change the default behavior when exporting from command
 152 line.
 153 .PP
 154 By default, LyX overwrites the main file when exporting from command
 155 line but not the ancillary files. This behavior can be changed by setting
 156 this environment variable, which relieves the need of using the \-f switch.
 157 Allowed values are either "\fBall\fR", "\fBmain\fR" or "\fBnone\fR", with
 158 same meaning as for the \-f switch.
 159 .SH FILES
 160 .nf
 161 .ta \w'\fILIBDIR\fR/lyxrc.in  'u
 162 ~/.lyx/preferences      Personal configuration file
 163 ~/.lyx/lyxrc.defaults   Personal autodetected configuration file
 164 \fILIBDIR\fR/lyxrc.dist  System wide configuration file
 165 \fILIBDIR\fR/configure.py  Updates \fBLyX\fR if config has changed
 166 \fILIBDIR\fR/bind/      Keybindings
 167 \fILIBDIR\fR/clipart/   Clipart pictures
 168 \fILIBDIR\fR/doc/       Documentation in \fBLyX\fR format.
 169 \fILIBDIR\fR/examples/  Example documents
 170 \fILIBDIR\fR/images/    Images used as icons or in popups
 171 \fILIBDIR\fR/kbd/       Keyboard mappings
 172 \fILIBDIR\fR/layouts/   Layout descriptions
 173 \fILIBDIR\fR/templates/ Templates for documents
 174 \fILIBDIR\fR/tex/       Extra TeX files
 175 .sp
 176 .fi
 177
 178 .I LIBDIR
 179 is the system directory. This was at build time @real_pkgdatadir@.
 180 .SH SEE ALSO
 181 tex2lyx@version_suffix@(1), latex(1).
 182
 183 Full documentation in either native \fBLyX\fR or postscript format.
 184 .SH BUGS/LIMITATIONS
 185 There are still some bugs in \fBLyX\fR. To report one, read if
 186 possible the Introduction found under the Help menu in LyX. You'll
 187 find detailed info on submitting bug reports there. If you can't do
 188 that, send details to the LyX Developers mailing list
 189 lyx\-devel@lists.lyx.org, or use the LyX bug tracker at
 190 http://www.lyx.org/trac/wiki/BugTrackerHome.
 191 Don't forget to mention which version you are having problems with!
 192
 193 \fBLaTeX\fR import is still not perfect and may produce buggy *.lyx
 194 files. Consult the \fBtex2lyx@version_suffix@\fR documentation.
 195
 196 .SH AUTHORS
 197 LyX is Copyright (C) 1995 by Matthias Ettrich, 1995-2017 LyX Team