1<?xml version="1.0" encoding="UTF-8"?>
2
3<!--***********************************************************
4 *
5 * Licensed to the Apache Software Foundation (ASF) under one
6 * or more contributor license agreements.  See the NOTICE file
7 * distributed with this work for additional information
8 * regarding copyright ownership.  The ASF licenses this file
9 * to you under the Apache License, Version 2.0 (the
10 * "License"); you may not use this file except in compliance
11 * with the License.  You may obtain a copy of the License at
12 *
13 *   http://www.apache.org/licenses/LICENSE-2.0
14 *
15 * Unless required by applicable law or agreed to in writing,
16 * software distributed under the License is distributed on an
17 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
18 * KIND, either express or implied.  See the License for the
19 * specific language governing permissions and limitations
20 * under the License.
21 *
22 ***********************************************************-->
23
24<helpdocument version="1.0">
25<meta>
26<topic id="textsharedguidestart_parametersxml" indexer="include" status="PUBLISH">
27<title id="tit" xml-lang="en-US">Starting the $[officename] Software With Parameters</title>
28<filename>/text/shared/guide/start_parameters.xhp</filename>
29</topic>
30</meta>
31<body>
32<section id="start_parameters">
33<bookmark xml-lang="en-US" branch="index" id="bm_id3156410">
34<bookmark_value>start parameters</bookmark_value>
35<bookmark_value>command line parameters</bookmark_value>
36<bookmark_value>parameters;command line</bookmark_value>
37<bookmark_value>arguments in command line</bookmark_value>
38</bookmark>
39<paragraph role="heading" id="hd_id3156410" xml-lang="en-US" level="1" l10n="U" oldref="52">Starting the $[officename] Software With Parameters</paragraph>
40<paragraph role="paragraph" id="par_id3147009" xml-lang="en-US" l10n="U" oldref="1">By starting the $[officename] software from the command line you can assign various parameters, with which you can influence the performance. The use of command line parameters is only recommended for experienced users.</paragraph>
41<paragraph role="note" id="par_id3147618" xml-lang="en-US" l10n="U" oldref="2">For normal handling, the use of command line parameters is not necessary. A few of the parameters require a deeper knowledge of the technical background of the $[officename] software technology.</paragraph>
42<paragraph role="heading" id="hd_id3154898" xml-lang="en-US" level="2" l10n="U" oldref="4">Starting the $[officename] Software From the Command Line</paragraph>
43<list type="ordered">
44<listitem>
45<paragraph role="listitem" id="par_id3156152" xml-lang="en-US" l10n="U" oldref="5">Under Windows, select <emph>Run</emph> from the Windows Start menu, or open a Shell under UNIX® based platforms.</paragraph>
46</listitem>
47<listitem>
48<paragraph role="listitem" id="par_id3152472" xml-lang="en-US" l10n="U" oldref="6">Under Windows, type the following text in the <emph>Open </emph>text field and click <emph>OK</emph>.</paragraph>
49</listitem>
50<listitem>
51<paragraph role="listitem" id="par_id3149669" xml-lang="en-US" l10n="U" oldref="53">Under UNIX based systems, type the following line of text, then press <emph>Return</emph>:</paragraph>
52<paragraph role="listitem" id="par_id3147561" xml-lang="en-US" l10n="U" oldref="7"><switchinline select="sys"><caseinline select="WIN">{install}\program\soffice.exe {parameter}
53</caseinline><caseinline select="UNIX">{install}/program/soffice {parameter}
54</caseinline></switchinline></paragraph>
55<paragraph role="listitem" id="par_id3153360" xml-lang="en-US" l10n="U" oldref="8">Replace <emph>{install}</emph> with the path to your installation of the $[officename] software (for example, <emph>C:\Program Files\Office</emph>, or <emph>~/office</emph>)</paragraph>
56<paragraph role="listitem" id="par_id3158407" xml-lang="en-US" l10n="U" oldref="9">Where required, replace <emph>{parameter}</emph> with one or more of the following command line parameters.</paragraph>
57</listitem>
58</list>
59<paragraph role="heading" id="hd_id3145171" xml-lang="en-US" level="2" l10n="U" oldref="10">Valid Command Line Parameters</paragraph>
60<table id="tbl_id3125864">
61<tablerow>
62<tablecell colspan="" rowspan="">
63<paragraph role="tablehead" id="par_id3148451" xml-lang="en-US" l10n="U" oldref="11">Parameter</paragraph>
64</tablecell>
65<tablecell colspan="" rowspan="">
66<paragraph role="tablehead" id="par_id3149167" xml-lang="en-US" l10n="U" oldref="12">Meaning</paragraph>
67</tablecell>
68</tablerow>
69<tablerow>
70<tablecell colspan="" rowspan="">
71<paragraph role="tablecontent" id="par_id3149983" xml-lang="en-US" l10n="U" oldref="73">-help / -h / -?</paragraph>
72</tablecell>
73<tablecell colspan="" rowspan="">
74<paragraph role="tablecontent" id="par_id3147349" xml-lang="en-US" l10n="CHG" oldref="74">Lists the available command line parameters <switchinline select="sys"><caseinline select="WIN">in a dialog box
75</caseinline><defaultinline>to the console</defaultinline></switchinline>.</paragraph>
76</tablecell>
77</tablerow>
78<tablerow>
79<tablecell colspan="" rowspan="">
80<paragraph role="tablecontent" id="par_id3150010" xml-lang="en-US" l10n="U" oldref="59">-writer</paragraph>
81</tablecell>
82<tablecell colspan="" rowspan="">
83<paragraph role="tablecontent" id="par_id3147213" xml-lang="en-US" l10n="U" oldref="60">Starts with an empty Writer document.</paragraph>
84</tablecell>
85</tablerow>
86<tablerow>
87<tablecell colspan="" rowspan="">
88<paragraph role="tablecontent" id="par_id3148616" xml-lang="en-US" l10n="U" oldref="61">-calc</paragraph>
89</tablecell>
90<tablecell colspan="" rowspan="">
91<paragraph role="tablecontent" id="par_id3145261" xml-lang="en-US" l10n="U" oldref="62">Starts with an empty Calc document.</paragraph>
92</tablecell>
93</tablerow>
94<tablerow>
95<tablecell colspan="" rowspan="">
96<paragraph role="tablecontent" id="par_id3156443" xml-lang="en-US" l10n="U" oldref="63">-draw</paragraph>
97</tablecell>
98<tablecell colspan="" rowspan="">
99<paragraph role="tablecontent" id="par_id3154011" xml-lang="en-US" l10n="U" oldref="64">Starts with an empty Draw document.</paragraph>
100</tablecell>
101</tablerow>
102<tablerow>
103<tablecell colspan="" rowspan="">
104<paragraph role="tablecontent" id="par_id3153142" xml-lang="en-US" l10n="U" oldref="65">-impress</paragraph>
105</tablecell>
106<tablecell colspan="" rowspan="">
107<paragraph role="tablecontent" id="par_id3153222" xml-lang="en-US" l10n="U" oldref="66">Starts with an empty Impress document.</paragraph>
108</tablecell>
109</tablerow>
110<tablerow>
111<tablecell colspan="" rowspan="">
112<paragraph role="tablecontent" id="par_id3155853" xml-lang="en-US" l10n="U" oldref="67">-math</paragraph>
113</tablecell>
114<tablecell colspan="" rowspan="">
115<paragraph role="tablecontent" id="par_id3146928" xml-lang="en-US" l10n="U" oldref="68">Starts with an empty Math document.</paragraph>
116</tablecell>
117</tablerow>
118<tablerow>
119<tablecell colspan="" rowspan="">
120<paragraph role="tablecontent" id="par_id3149960" xml-lang="en-US" l10n="U" oldref="69">-global</paragraph>
121</tablecell>
122<tablecell colspan="" rowspan="">
123<paragraph role="tablecontent" id="par_id3151075" xml-lang="en-US" l10n="CHG" oldref="70">Starts with an empty Writer master document.</paragraph>
124</tablecell>
125</tablerow>
126<tablerow>
127<tablecell colspan="" rowspan="">
128<paragraph role="tablecontent" id="par_id3154510" xml-lang="en-US" l10n="U" oldref="71">-web</paragraph>
129</tablecell>
130<tablecell colspan="" rowspan="">
131<paragraph role="tablecontent" id="par_id3148836" xml-lang="en-US" l10n="U" oldref="72">Starts with an empty HTML document.</paragraph>
132</tablecell>
133</tablerow>
134<tablerow>
135<tablecell colspan="" rowspan="">
136<paragraph role="tablecontent" id="par_id3149403" xml-lang="en-US" l10n="CHG">-show {filename.odp}</paragraph>
137</tablecell>
138<tablecell colspan="" rowspan="">
139<paragraph role="tablecontent" id="par_id3153838" xml-lang="en-US" l10n="CHG" oldref="80">Starts with the Impress file <emph>{filename.odp}</emph> and starts the presentation. Enters edit mode after the presentation.</paragraph>
140</tablecell>
141</tablerow>
142<tablerow>
143<tablecell colspan="" rowspan="">
144<paragraph role="tablecontent" id="par_id3156276" xml-lang="en-US" l10n="U" oldref="13">-minimized</paragraph>
145</tablecell>
146<tablecell colspan="" rowspan="">
147<paragraph role="tablecontent" id="par_id3146080" xml-lang="en-US" l10n="U" oldref="14">Starts minimized. The splash screen is not displayed.</paragraph>
148</tablecell>
149</tablerow>
150<tablerow>
151<tablecell colspan="" rowspan="">
152<paragraph role="tablecontent" id="par_id3641773" xml-lang="en-US" l10n="NEW">-maximized</paragraph>
153</tablecell>
154<tablecell colspan="" rowspan="">
155<paragraph role="tablecontent" id="par_id8224433" xml-lang="en-US" l10n="NEW">Starts maximized.<comment>see i72749</comment></paragraph>
156</tablecell>
157</tablerow>
158<tablerow>
159<tablecell colspan="" rowspan="">
160<paragraph role="tablecontent" id="par_id3145641" xml-lang="en-US" l10n="U" oldref="15">-invisible</paragraph>
161</tablecell>
162<tablecell colspan="" rowspan="">
163<paragraph role="tablecontent" id="par_id3154756" xml-lang="en-US" l10n="U" oldref="16">Starts in invisible mode.</paragraph>
164<paragraph role="tablecontent" id="par_id3148914" xml-lang="en-US" l10n="U" oldref="17">Neither the start-up logo nor the initial program window will be visible. However, the $[officename] software can be controlled and documents and dialogs opened via the <link href="https://api.openoffice.org" name="API">API</link>.</paragraph>
165<paragraph role="tablecontent" id="par_id3147341" xml-lang="en-US" l10n="U" oldref="18">When the $[officename] software has been started with this parameter, it can only be ended using the taskmanager (Windows) or the <emph>kill </emph>command (UNIX based systems).</paragraph>
166<paragraph role="tablecontent" id="par_id3150388" xml-lang="en-US" l10n="U" oldref="48">It cannot be used in conjunction with <emph>-quickstart</emph>.</paragraph>
167<paragraph role="tablecontent" id="par_id3145147" xml-lang="en-US" l10n="U" oldref="19">More information is found in the <emph>$[officename] Developer's Guide</emph>.</paragraph>
168</tablecell>
169</tablerow>
170<!--<tablerow>
171<tablecell colspan="" rowspan="">
172<paragraph role="tablecontent" id="par_id3155334" xml-lang="en-US" l10n="U" oldref="77">-nocrashreport</paragraph>
173</tablecell>
174<tablecell colspan="" rowspan="">
175<paragraph role="tablecontent" id="par_id3149259" xml-lang="en-US" l10n="U" oldref="78">Disables the error report tool.</paragraph>
176</tablecell>
177</tablerow>
178-->
179<tablerow>
180<tablecell colspan="" rowspan="">
181<paragraph role="tablecontent" id="par_id3155903" xml-lang="en-US" l10n="U" oldref="20">-norestore</paragraph>
182</tablecell>
183<tablecell colspan="" rowspan="">
184<paragraph role="tablecontent" id="par_id3156374" xml-lang="en-US" l10n="U" oldref="21">Disables restart and file recovery after a system crash.</paragraph>
185</tablecell>
186</tablerow>
187<tablerow>
188<tablecell colspan="" rowspan="">
189<paragraph role="tablecontent" id="par_id5215918" xml-lang="en-US" l10n="NEW">-nofirststartwizard</paragraph>
190</tablecell>
191<tablecell colspan="" rowspan="">
192<paragraph role="tablecontent" id="par_id5665761" xml-lang="en-US" l10n="NEW">Disables the Welcome Wizard.</paragraph>
193</tablecell>
194</tablerow>
195<tablerow>
196<tablecell colspan="" rowspan="">
197<paragraph role="tablecontent" id="par_id3148477" xml-lang="en-US" l10n="U" oldref="25">-quickstart</paragraph>
198</tablecell>
199<tablecell colspan="" rowspan="">
200<paragraph role="tablecontent" id="par_id3153919" xml-lang="en-US" l10n="CHG" oldref="26">Activates the Quickstarter.<comment>now on UNIX too</comment></paragraph>
201</tablecell>
202</tablerow>
203<tablerow>
204<tablecell colspan="" rowspan="">
205<paragraph role="tablecontent" id="par_id3152479" xml-lang="en-US" l10n="U" oldref="30">-accept={UNO string}</paragraph>
206</tablecell>
207<tablecell colspan="" rowspan="">
208<paragraph role="tablecontent" id="par_id3147130" xml-lang="en-US" l10n="U" oldref="31">Notifies the $[officename] software that upon the creation of "UNO Acceptor Threads", a "UNO Accept String" will be used.</paragraph>
209<paragraph role="tablecontent" id="par_id3148874" xml-lang="en-US" l10n="U" oldref="32">More information is found in the <emph>$[officename] Developer's Guide</emph>.</paragraph>
210</tablecell>
211</tablerow>
212<tablerow>
213<tablecell colspan="" rowspan="">
214<paragraph role="tablecontent" id="par_id3149964" xml-lang="en-US" l10n="CHG" oldref="33">-env</paragraph>
215</tablecell>
216<tablecell colspan="" rowspan="">
217<paragraph role="tablecontent" id="par_id2439039" xml-lang="en-US" l10n="NEW">Sets another environment for the program start.<comment>UFI: just guessing. Cannot find any info</comment></paragraph>
218<paragraph role="tablecontent" id="par_id2789086" xml-lang="en-US" l10n="NEW">Use soffice -env:UserInstallation=$(URL) where $(URL) is the URL of a folder that contains the "user" folder.<comment>this is from http://www.mail-archive.com/dev@api.openoffice.org/msg04728.html</comment></paragraph>
219</tablecell>
220</tablerow>
221<tablerow>
222<tablecell colspan="" rowspan="">
223<paragraph role="tablecontent" id="par_id3159238" xml-lang="en-US" l10n="U" oldref="36">-p {filename1} {filename2} ...</paragraph>
224</tablecell>
225<tablecell colspan="" rowspan="">
226<paragraph role="tablecontent" id="par_id3163666" xml-lang="en-US" l10n="U" oldref="37">Prints the files <emph>{filename1} {filename2} ...</emph> to the default printer and ends. The splash screen does not appear.</paragraph>
227<paragraph role="tablecontent" id="par_id3150828" xml-lang="en-US" l10n="CHG" oldref="49">If the file name contains spaces, then it must be enclosed in quotation marks.</paragraph>
228</tablecell>
229</tablerow>
230<tablerow>
231<tablecell colspan="" rowspan="">
232<paragraph role="tablecontent" id="par_id3150883" xml-lang="en-US" l10n="U" oldref="38">-pt {Printername} {filename1} {filename2} ...</paragraph>
233</tablecell>
234<tablecell colspan="" rowspan="">
235<paragraph role="tablecontent" id="par_id3155081" xml-lang="en-US" l10n="U" oldref="50">Prints the files <emph>{filename1} {filename2} ...</emph> to the printer <emph>{Printername}</emph> and ends. The splash screen does not appear.</paragraph>
236<paragraph role="tablecontent" id="par_id3153655" xml-lang="en-US" l10n="CHG" oldref="51">If the file name contains spaces, then it must be enclosed in quotation marks.</paragraph>
237</tablecell>
238</tablerow>
239<tablerow>
240<tablecell colspan="" rowspan="">
241<paragraph role="tablecontent" id="par_id3154372" xml-lang="en-US" l10n="U" oldref="39">-o {filename}</paragraph>
242</tablecell>
243<tablecell colspan="" rowspan="">
244<paragraph role="tablecontent" id="par_id3150309" xml-lang="en-US" l10n="U" oldref="40">Opens <emph>{filename}</emph> for editing, even if it is a template.</paragraph>
245</tablecell>
246</tablerow>
247<tablerow>
248<tablecell colspan="" rowspan="">
249<paragraph role="tablecontent" id="par_id3151182" xml-lang="en-US" l10n="U" oldref="54">-view {filename}</paragraph>
250</tablecell>
251<tablecell colspan="" rowspan="">
252<paragraph role="tablecontent" id="par_id3145268" xml-lang="en-US" l10n="U" oldref="55">Creates a temporary copy of <emph>{filename}</emph> and opens it read-only.</paragraph>
253</tablecell>
254</tablerow>
255<tablerow>
256<tablecell colspan="" rowspan="">
257<paragraph role="tablecontent" id="par_id3166421" xml-lang="en-US" l10n="U" oldref="41">-n {filename}</paragraph>
258</tablecell>
259<tablecell colspan="" rowspan="">
260<paragraph role="tablecontent" id="par_id3154259" xml-lang="en-US" l10n="U" oldref="42">Creates a new document using <emph>{filename}</emph> as a template.</paragraph>
261</tablecell>
262</tablerow>
263<tablerow>
264<tablecell colspan="" rowspan="">
265<paragraph role="tablecontent" id="par_id3155126" xml-lang="en-US" l10n="U" oldref="43">-nologo</paragraph>
266</tablecell>
267<tablecell colspan="" rowspan="">
268<paragraph role="tablecontent" id="par_id3151334" xml-lang="en-US" l10n="U" oldref="44">Disables the splash screen at program start.</paragraph>
269</tablecell>
270</tablerow>
271<tablerow>
272<tablecell colspan="" rowspan="">
273<paragraph role="tablecontent" id="par_id3159171" xml-lang="en-US" l10n="U" oldref="75">-nodefault</paragraph>
274</tablecell>
275<tablecell colspan="" rowspan="">
276<paragraph role="tablecontent" id="par_id3153306" xml-lang="en-US" l10n="CHG" oldref="76">Starts without displaying anything except the splash screen.</paragraph>
277</tablecell>
278</tablerow>
279<tablerow>
280<tablecell colspan="" rowspan="">
281<paragraph role="tablecontent" id="par_id2211676" xml-lang="en-US" l10n="NEW">-nofirststartwizard</paragraph>
282</tablecell>
283<tablecell colspan="" rowspan="">
284<paragraph role="tablecontent" id="par_id1641895" xml-lang="en-US" l10n="NEW">Add this parameter to the program start command to suppress the Welcome Wizard.<comment>see i72749</comment></paragraph>
285</tablecell>
286</tablerow>
287<tablerow>
288<tablecell colspan="" rowspan="">
289<paragraph role="tablecontent" id="par_id3153915" xml-lang="en-US" l10n="U" oldref="45">-display {display}</paragraph>
290</tablecell>
291<tablecell colspan="" rowspan="">
292<paragraph role="tablecontent" id="par_id3146786" xml-lang="en-US" l10n="U" oldref="46">Sets the <emph>DISPLAY</emph> environment variable on UNIX based platforms to the value <emph>{display}</emph>. This parameter is only supported by the start script for the $[officename] software on UNIX based platforms.</paragraph>
293</tablecell>
294</tablerow>
295<tablerow>
296<tablecell colspan="" rowspan="">
297<paragraph role="tablecontent" id="par_id3149595" xml-lang="en-US" l10n="U" oldref="56">-headless</paragraph>
298</tablecell>
299<tablecell colspan="" rowspan="">
300<paragraph role="tablecontent" id="par_id3150530" xml-lang="en-US" l10n="U" oldref="57">Starts in "headless mode" which allows using the application without user interface.</paragraph>
301<paragraph role="tablecontent" id="par_id3156353" xml-lang="en-US" l10n="U" oldref="58">This special mode can be used when the application is controlled by external clients via the <link href="https://api.openoffice.org" name="API">API</link>.</paragraph>
302</tablecell>
303</tablerow>
304</table>
305<comment>see i70904 for more parameters:
306-terminate_after_init
307-plugin
308-bean
309-clientdisplay
310-userid</comment>
311</section>
312</body>
313</helpdocument>
314