]> git.lyx.org Git - lyx.git/blobdiff - lyx.1in
Whitespace
[lyx.git] / lyx.1in
diff --git a/lyx.1in b/lyx.1in
index e92eef872a1a744a03339716da87c451043023cd..89736cfd4df0c79462e55d007775c38c5a3665c2 100644 (file)
--- a/lyx.1in
+++ b/lyx.1in
@@ -36,9 +36,9 @@ 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 Qt4 library as a
+Currently, \fBLyX\fR uses the Qt library as a
 toolkit. \fBLyX\fR should run everywhere, where this library runs.
-This is on all major Unix platforms as well as Windows and Mac OS X
+This is on all major Unix platforms as well as Windows and macOS
 (which actually is a unix platform).
 .SH OPTIONS
 \fBLyX\fR supports the following command\-line switches.
@@ -67,23 +67,62 @@ Use "\fBlyx@version_suffix@ \-dbg\fR" to see the list of available debug feature
 where command is a lyx command.
 .TP
 \fB \-e [\-\-export]\fP \fIfmt
-where fmt is the export format of choice.
-Look on Tools->Preferences->File formats->Format to get an idea which parameters should be passed.
-Note that the order of -e and -x switches matters.
+where fmt is the export format of choice (latex, pdflatex, luatex, xetex, xhtml, text, lyx, ps, pdf, ...).
+Note that the order of \-e and \-x switches matters.
+.TP
+\fB \-E [\-\-export\-to]\fP \fIfmt \fIfilename
+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).
 .TP
 \fB \-i [\-\-import]\fP \fIfmt file.xxx
 where fmt is the import format of choice and file.xxx is the file to be imported.
 .TP
-.BI --batch
+\fB \-f [\-\-force\-overwrite]\fP \fIwhat
+where what is is either "\fBall\fR", "\fBmain\fR" or "\fBnone\fR".
+Specify "\fBall\fR" to allow overwriting all files during a batch export,
+"\fBmain\fR" to allow overwriting the main file only, or "\fBnone\fR"
+to disallow overwriting any file. When this switch is followed by anything
+else other than "\fBall\fR", "\fBmain\fR" or "\fBnone\fR", the behavior is as
+if "\fBall\fR" was specified, but what follows is left on the command line for
+further processing.
+.TP
+\fB \-\-ignore\-error\-message\fP \fIwhich
+allows you to ignore specific LaTeX error messages.
+Do not use for final documents! Currently supported values:
+"\fBmissing_glyphs\fR" Fontspec "missing glyphs" error.
+.TP
+\fB \-n [\-\-no\-remote]\fP
+open documents passed as arguments in a new instance, even if another
+instance of LyX is already running.
+.TP
+\fB \-r [\-\-remote]\fP
+by using the lyxpipe, ask an already running instance of LyX to open the
+documents passed as arguments and then exit. If the lyxpipe is not set up or
+is not working, a new instance is created and execution continues normally.
+.TP
+\fB \-v [\-\-verbose]\fP
+print on terminal all spawned external commands.
+.TP
+.BI \-batch
 causes LyX to run the given commands without opening a GUI window.
 Thus, something like:
 .br
-    lyx --batch -x "buffer-print printer default dvips" myfile.lyx
+    lyx \-batch \-x "buffer\-print printer default dvips" myfile.lyx
 .br
 will cause LyX to print myfile.lyx to the default printer, using dvips and
 the default print settings (which, of course, have to have been configured
 already).
 
+.SH QT OPTIONS
+\fBLyX\fR is a Qt-based application and thus recognizes common options implemented
+by Qt itself (notably \fB-platform\fR, \fB-style\fR, \fB-geometry\fR, \fB-session\fR,
+\fB-display\fR, etc). Please consult Qt documentation for further details, e.g.:
+.br
+
+https://doc.qt.io/qt-5/qapplication.html#QApplication
+.br
+https://doc.qt.io/qt-5/qguiapplication.html#supported-command-line-options
+.br
+
 .SH ENVIRONMENT
 .TP
 .B @LYX_DIR_VER@
@@ -117,6 +156,17 @@ The user directory is, in order of precedence:
 .B LYX_LOCALEDIR
 can be used to tell LyX where to look for the translations of its GUI
 strings in other languages.
+
+.TP
+.B LYX_FORCE_OVERWRITE
+can be used to change the default behavior when exporting from command
+line.
+.PP
+By default, LyX overwrites the main file when exporting from command
+line but not the ancillary files. This behavior can be changed by setting
+this environment variable, which relieves the need of using the \-f switch.
+Allowed values are either "\fBall\fR", "\fBmain\fR" or "\fBnone\fR", with
+same meaning as for the \-f switch.
 .SH FILES
 .nf
 .ta \w'\fILIBDIR\fR/lyxrc.in  'u
@@ -148,11 +198,11 @@ 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!
+http://www.lyx.org/trac/wiki/BugTrackerHome.
+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 \fBtex2lyx@version_suffix@\fR documentation.
 
 .SH AUTHORS
-LyX is Copyright (C) 1995 by Matthias Ettrich, 1995-2009 LyX Team
+LyX is Copyright (C) 1995 by Matthias Ettrich, 1995-2023 LyX Team