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 Qt 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 macOS
  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 QT OPTIONS
 116 \fBLyX\fR is a Qt-based application and thus recognizes common options implemented
 117 by Qt itself (notably \fB-platform\fR, \fB-style\fR, \fB-geometry\fR, \fB-session\fR,
 118 \fB-display\fR, etc). Please consult Qt documentation for further details, e.g.:
 119 .br
 120
 121 https://doc.qt.io/qt-5/qapplication.html#QApplication
 122 .br
 123 https://doc.qt.io/qt-5/qguiapplication.html#supported-command-line-options
 124 .br
 125
 126 .SH ENVIRONMENT
 127 .TP
 128 .B @LYX_DIR_VER@
 129 can be used to specify which system directory to use.
 130 .PP
 131 The system directory is determined by searching for the file
 132 "chkconfig.ltx". Directories are searched in this order:
 133 .br
 134 1) \-sysdir command line parameter
 135 .br
 136 2) @LYX_DIR_VER@ environment variable
 137 .br
 138 3) Maybe <path of binary>/TOP_SRCDIR/lib
 139 .br
 140 4) <path of binary>/../share/<name of binary>/
 141 .br
 142 5) hardcoded lyx_dir (at build time: @real_pkgdatadir@)
 143 .TP
 144 .B @LYX_USERDIR_VER@
 145 can be used to specify which user directory to use.
 146 .PP
 147 The user directory is, in order of precedence:
 148 .br
 149 1) \-userdir command line parameter
 150 .br
 151 2) @LYX_USERDIR_VER@ environment variable
 152 .br
 153 3) $HOME/.<name of binary> if no explicit setting is made
 154
 155 .TP
 156 .B LYX_LOCALEDIR
 157 can be used to tell LyX where to look for the translations of its GUI
 158 strings in other languages.
 159
 160 .TP
 161 .B LYX_FORCE_OVERWRITE
 162 can be used to change the default behavior when exporting from command
 163 line.
 164 .PP
 165 By default, LyX overwrites the main file when exporting from command
 166 line but not the ancillary files. This behavior can be changed by setting
 167 this environment variable, which relieves the need of using the \-f switch.
 168 Allowed values are either "\fBall\fR", "\fBmain\fR" or "\fBnone\fR", with
 169 same meaning as for the \-f switch.
 170 .SH FILES
 171 .nf
 172 .ta \w'\fILIBDIR\fR/lyxrc.in  'u
 173 ~/.lyx/preferences      Personal configuration file
 174 ~/.lyx/lyxrc.defaults   Personal autodetected configuration file
 175 \fILIBDIR\fR/lyxrc.dist  System wide configuration file
 176 \fILIBDIR\fR/configure.py  Updates \fBLyX\fR if config has changed
 177 \fILIBDIR\fR/bind/      Keybindings
 178 \fILIBDIR\fR/clipart/   Clipart pictures
 179 \fILIBDIR\fR/doc/       Documentation in \fBLyX\fR format.
 180 \fILIBDIR\fR/examples/  Example documents
 181 \fILIBDIR\fR/images/    Images used as icons or in popups
 182 \fILIBDIR\fR/kbd/       Keyboard mappings
 183 \fILIBDIR\fR/layouts/   Layout descriptions
 184 \fILIBDIR\fR/templates/ Templates for documents
 185 \fILIBDIR\fR/tex/       Extra TeX files
 186 .sp
 187 .fi
 188
 189 .I LIBDIR
 190 is the system directory. This was at build time @real_pkgdatadir@.
 191 .SH SEE ALSO
 192 tex2lyx@version_suffix@(1), latex(1).
 193
 194 Full documentation in either native \fBLyX\fR or postscript format.
 195 .SH BUGS/LIMITATIONS
 196 There are still some bugs in \fBLyX\fR. To report one, read if
 197 possible the Introduction found under the Help menu in LyX. You'll
 198 find detailed info on submitting bug reports there. If you can't do
 199 that, send details to the LyX Developers mailing list
 200 lyx\-devel@lists.lyx.org, or use the LyX bug tracker at
 201 http://www.lyx.org/trac/wiki/BugTrackerHome.
 202 Don't forget to mention which version you are having problems with!
 203
 204 \fBLaTeX\fR import is still not perfect and may produce buggy *.lyx
 205 files. Consult the \fBtex2lyx@version_suffix@\fR documentation.
 206
 207 .SH AUTHORS
 208 LyX is Copyright (C) 1995 by Matthias Ettrich, 1995-2023 LyX Team