]> git.lyx.org Git - lyx.git/blob - lib/examples/linuxdoc_manpage.lyx
Implement return codes consistently.
[lyx.git] / lib / examples / linuxdoc_manpage.lyx
1 #LyX 1.3 created this file. For more info see http://www.lyx.org/
2 \lyxformat 221
3 \textclass manpage
4 \options title="LyX" sectnum="1"
5 \language english
6 \inputencoding default
7 \fontscheme default
8 \graphics default
9 \paperfontsize 10
10 \spacing single
11 \papersize Default
12 \paperpackage a4
13 \use_geometry 0
14 \use_amsmath 0
15 \use_natbib 0
16 \use_numerical_citations 0
17 \paperorientation portrait
18 \secnumdepth -2
19 \tocdepth -1
20 \paragraph_separation indent
21 \defskip medskip
22 \quotes_language english
23 \quotes_times 2
24 \papercolumns 1
25 \papersides 1
26 \paperpagestyle default
27
28 \layout Section
29
30 Name
31 \layout Standard
32
33 lyx - A Document Processor
34 \layout Section
35
36 Synopsis
37 \layout Standard
38
39 lyx [ command-line switches] [name.lyx ...
40  ] 
41 \layout Section
42
43 Description
44 \layout Standard
45
46
47 \emph on 
48 LyX
49 \emph default 
50  is too complex to be described completely in the "man" page format.
51  If your system is properly configured, you can access the full documentation
52  within 
53 \emph on 
54 LyX
55 \emph default 
56  under the Help menu.
57  
58 \layout Standard
59
60
61 \emph on 
62 LyX
63 \emph default 
64  is a modern approach of writing documents with a computer which breaks
65  with the tradition of the obsolete typewriter concept.
66  It is designed for people who want a professional output with a minimum
67  of time effort, without becoming specialists in typesetting.
68  Compared to common word processors, 
69 \emph on 
70 LyX
71 \emph default 
72  will increase the productivity a lot, since most of the typesetting will
73  be done by the computer, not the author.
74  With 
75 \emph on 
76 LyX
77 \emph default 
78  the author can concentrate on the contents of his writing, since the computer
79  will take care of the look.
80  Read more about this concept in the online documentation under the Help
81  menu.
82  
83 \layout Standard
84
85 Currently, 
86 \emph on 
87 LyX
88 \emph default 
89  uses the XForms library as a toolkit.
90  
91 \emph on 
92 LyX
93 \emph default 
94  should run everywhere, where XForms runs.
95  This is on all major Unix platforms as well as some PC platforms, including
96  Sun, SGI, HP, Compaq Tru64, IBM RS6000, Convex, Cray, i386/Linux, Alpha/Linux,
97  i386/FreeBSD, i386/NetBSD, DecSystem(mips)/Ultrix, OS/2 with XFree or PMX
98  and others.
99  
100 \layout Section
101
102 Options
103 \layout Standard
104
105
106 \emph on 
107 LyX
108 \emph default 
109  supports the following command-line switches, which can also be specified
110  as X resources (e.
111  g.
112  in .Xdefaults) with class name 
113 \emph on 
114 LyX
115 \emph default 
116
117 \layout Description
118
119 -help summarizes LyX usage
120 \layout Description
121
122 -sysdir directory sets system directory.
123  Normally not needed.
124 \layout Description
125
126 -userdir directory sets user directory.
127  Needed if you want to use LyX with different lyxrc settings.
128 \layout Description
129
130 -geometry WxH+X+Y specifies the preferred size and position of the main
131  LyX window; see X(1).
132 \layout Description
133
134 -dbg feature[,feature...] where feature is a name or number.
135  Use "lyx -dbg" to see the list of available debug features.
136 \layout Description
137
138 -x [--execute] command where command is a lyx command.
139 \layout Description
140
141 -e [--export] fmt where fmt is the export format of choice.
142 \layout Description
143
144 -i [--import] fmt file.xxx where fmt is the import format of choice and file.xxx
145  is the file to be imported.
146  
147 \layout Standard
148
149 Furthermore, LyX understands the following generic command line options
150  from the Forms Library: 
151 \layout Description
152
153 -display host:display specifies the server to connect to.
154 \layout Description
155
156 -bw borderwidth specifies the border width to use to built-in objects.
157 \layout Description
158
159 -visual visualName requests a visual by name such as TrueColor etc.
160  By default the Forms Library always selects the visual that has the most
161  depth.
162 \layout Description
163
164 -depth depth requests a specific depth.
165  Try "-depth best" or "-depth 8" if you get a bad match.
166 \layout Description
167
168 -debug level generates some info about the state of the XForms.
169  where level is an integer between 1-5 and controls the amount of information
170  to output.
171  Depending on the options used when the Forms Library was built, a level
172  more than 3 might not be available.
173 \layout Description
174
175 -sync runs the application in synchronous mode with debug level set to 4.
176 \layout Description
177
178 -private requests a private colormap for the application.
179 \layout Description
180
181 -shared requests a shared colormap even if the application needs more colors
182  than available.
183  For those colors that can't be allocated in the shared colormap, substitutions
184  are made so the closest matching color is used.
185 \layout Description
186
187 -stdcmap requests a standard colormap.
188 \layout Description
189
190 -name newname specifies the application name under which resources are to
191  be obtained, rather than the default executable file name.
192  
193 \the_end