1<?xml version="1.0" encoding="UTF-8"?>
2
3
4<!--***********************************************************
5 *
6 * Licensed to the Apache Software Foundation (ASF) under one
7 * or more contributor license agreements.  See the NOTICE file
8 * distributed with this work for additional information
9 * regarding copyright ownership.  The ASF licenses this file
10 * to you under the Apache License, Version 2.0 (the
11 * "License"); you may not use this file except in compliance
12 * with the License.  You may obtain a copy of the License at
13 *
14 *   http://www.apache.org/licenses/LICENSE-2.0
15 *
16 * Unless required by applicable law or agreed to in writing,
17 * software distributed under the License is distributed on an
18 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
19 * KIND, either express or implied.  See the License for the
20 * specific language governing permissions and limitations
21 * under the License.
22 *
23 ***********************************************************-->
24
25
26
27<helpdocument version="1.0">
28<meta>
29<topic id="textsharedguidestart_parametersxml" indexer="include" status="PUBLISH">
30<title id="tit" xml-lang="en-US">Starting the $[officename] Software With Parameters</title>
31<filename>/text/shared/guide/start_parameters.xhp</filename>
32</topic>
33</meta>
34<body>
35<section id="start_parameters">
36<bookmark xml-lang="en-US" branch="index" id="bm_id3156410"><bookmark_value>start parameters</bookmark_value>
37<bookmark_value>command line parameters</bookmark_value>
38<bookmark_value>parameters;command line</bookmark_value>
39<bookmark_value>arguments in command line</bookmark_value>
40</bookmark>
41<paragraph role="heading" id="hd_id3156410" xml-lang="en-US" level="1" l10n="U" oldref="52">Starting the $[officename] Software With Parameters</paragraph>
42<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>
43<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>
44<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>
45<list type="ordered">
46<listitem>
47<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>
48</listitem>
49<listitem>
50<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>
51</listitem>
52<listitem>
53<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>
54<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}
55</caseinline><caseinline select="UNIX">{install}/program/soffice {parameter}
56</caseinline></switchinline></paragraph>
57<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>
58<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>
59</listitem>
60</list>
61<paragraph role="heading" id="hd_id3145171" xml-lang="en-US" level="2" l10n="U" oldref="10">Valid Command Line Parameters</paragraph>
62<table id="tbl_id3125864">
63<tablerow>
64<tablecell colspan="" rowspan="">
65<paragraph role="tablehead" id="par_id3148451" xml-lang="en-US" l10n="U" oldref="11">Parameter</paragraph>
66</tablecell>
67<tablecell colspan="" rowspan="">
68<paragraph role="tablehead" id="par_id3149167" xml-lang="en-US" l10n="U" oldref="12">Meaning</paragraph>
69</tablecell>
70</tablerow>
71<tablerow>
72<tablecell colspan="" rowspan="">
73<paragraph role="tablecontent" id="par_id3149983" xml-lang="en-US" l10n="U" oldref="73">-help / -h / -?</paragraph>
74</tablecell>
75<tablecell colspan="" rowspan="">
76<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
77</caseinline><defaultinline>to the console</defaultinline></switchinline>.</paragraph>
78</tablecell>
79</tablerow>
80<tablerow>
81<tablecell colspan="" rowspan="">
82<paragraph role="tablecontent" id="par_id3150010" xml-lang="en-US" l10n="U" oldref="59">-writer</paragraph>
83</tablecell>
84<tablecell colspan="" rowspan="">
85<paragraph role="tablecontent" id="par_id3147213" xml-lang="en-US" l10n="U" oldref="60">Starts with an empty Writer document.</paragraph>
86</tablecell>
87</tablerow>
88<tablerow>
89<tablecell colspan="" rowspan="">
90<paragraph role="tablecontent" id="par_id3148616" xml-lang="en-US" l10n="U" oldref="61">-calc</paragraph>
91</tablecell>
92<tablecell colspan="" rowspan="">
93<paragraph role="tablecontent" id="par_id3145261" xml-lang="en-US" l10n="U" oldref="62">Starts with an empty Calc document.</paragraph>
94</tablecell>
95</tablerow>
96<tablerow>
97<tablecell colspan="" rowspan="">
98<paragraph role="tablecontent" id="par_id3156443" xml-lang="en-US" l10n="U" oldref="63">-draw</paragraph>
99</tablecell>
100<tablecell colspan="" rowspan="">
101<paragraph role="tablecontent" id="par_id3154011" xml-lang="en-US" l10n="U" oldref="64">Starts with an empty Draw document.</paragraph>
102</tablecell>
103</tablerow>
104<tablerow>
105<tablecell colspan="" rowspan="">
106<paragraph role="tablecontent" id="par_id3153142" xml-lang="en-US" l10n="U" oldref="65">-impress</paragraph>
107</tablecell>
108<tablecell colspan="" rowspan="">
109<paragraph role="tablecontent" id="par_id3153222" xml-lang="en-US" l10n="U" oldref="66">Starts with an empty Impress document.</paragraph>
110</tablecell>
111</tablerow>
112<tablerow>
113<tablecell colspan="" rowspan="">
114<paragraph role="tablecontent" id="par_id3155853" xml-lang="en-US" l10n="U" oldref="67">-math</paragraph>
115</tablecell>
116<tablecell colspan="" rowspan="">
117<paragraph role="tablecontent" id="par_id3146928" xml-lang="en-US" l10n="U" oldref="68">Starts with an empty Math document.</paragraph>
118</tablecell>
119</tablerow>
120<tablerow>
121<tablecell colspan="" rowspan="">
122<paragraph role="tablecontent" id="par_id3149960" xml-lang="en-US" l10n="U" oldref="69">-global</paragraph>
123</tablecell>
124<tablecell colspan="" rowspan="">
125<paragraph role="tablecontent" id="par_id3151075" xml-lang="en-US" l10n="CHG" oldref="70">Starts with an empty Writer master document.</paragraph>
126</tablecell>
127</tablerow>
128<tablerow>
129<tablecell colspan="" rowspan="">
130<paragraph role="tablecontent" id="par_id3154510" xml-lang="en-US" l10n="U" oldref="71">-web</paragraph>
131</tablecell>
132<tablecell colspan="" rowspan="">
133<paragraph role="tablecontent" id="par_id3148836" xml-lang="en-US" l10n="U" oldref="72">Starts with an empty HTML document.</paragraph>
134</tablecell>
135</tablerow>
136<tablerow>
137<tablecell colspan="" rowspan="">
138<paragraph role="tablecontent" id="par_id3149403" xml-lang="en-US" l10n="CHG">-show {filename.odp}</paragraph>
139</tablecell>
140<tablecell colspan="" rowspan="">
141<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>
142</tablecell>
143</tablerow>
144<tablerow>
145<tablecell colspan="" rowspan="">
146<paragraph role="tablecontent" id="par_id3156276" xml-lang="en-US" l10n="U" oldref="13">-minimized</paragraph>
147</tablecell>
148<tablecell colspan="" rowspan="">
149<paragraph role="tablecontent" id="par_id3146080" xml-lang="en-US" l10n="U" oldref="14">Starts minimized. The splash screen is not displayed.</paragraph>
150</tablecell>
151</tablerow>
152<tablerow>
153<tablecell colspan="" rowspan="">
154<paragraph role="tablecontent" id="par_id3641773" xml-lang="en-US" l10n="NEW">-maximized</paragraph>
155</tablecell>
156<tablecell colspan="" rowspan="">
157<paragraph role="tablecontent" id="par_id8224433" xml-lang="en-US" l10n="NEW">Starts maximized.<comment>see i72749</comment></paragraph>
158</tablecell>
159</tablerow>
160<tablerow>
161<tablecell colspan="" rowspan="">
162<paragraph role="tablecontent" id="par_id3145641" xml-lang="en-US" l10n="U" oldref="15">-invisible</paragraph>
163</tablecell>
164<tablecell colspan="" rowspan="">
165<paragraph role="tablecontent" id="par_id3154756" xml-lang="en-US" l10n="U" oldref="16">Starts in invisible mode.</paragraph>
166<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>
167<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>
168<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>
169<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>
170</tablecell>
171</tablerow>
172<!--<tablerow>
173<tablecell colspan="" rowspan="">
174<paragraph role="tablecontent" id="par_id3155334" xml-lang="en-US" l10n="U" oldref="77">-nocrashreport</paragraph>
175</tablecell>
176<tablecell colspan="" rowspan="">
177<paragraph role="tablecontent" id="par_id3149259" xml-lang="en-US" l10n="U" oldref="78">Disables the error report tool.</paragraph>
178</tablecell>
179</tablerow>
180-->
181<tablerow>
182<tablecell colspan="" rowspan="">
183<paragraph role="tablecontent" id="par_id3155903" xml-lang="en-US" l10n="U" oldref="20">-norestore</paragraph>
184</tablecell>
185<tablecell colspan="" rowspan="">
186<paragraph role="tablecontent" id="par_id3156374" xml-lang="en-US" l10n="U" oldref="21">Disables restart and file recovery after a system crash.</paragraph>
187</tablecell>
188</tablerow>
189<tablerow>
190<tablecell colspan="" rowspan="">
191<paragraph role="tablecontent" id="par_id5215918" xml-lang="en-US" l10n="NEW">-nofirststartwizard</paragraph>
192</tablecell>
193<tablecell colspan="" rowspan="">
194<paragraph role="tablecontent" id="par_id5665761" xml-lang="en-US" l10n="NEW">Disables the Welcome Wizard.</paragraph>
195</tablecell>
196</tablerow>
197<tablerow>
198<tablecell colspan="" rowspan="">
199<paragraph role="tablecontent" id="par_id3148477" xml-lang="en-US" l10n="U" oldref="25">-quickstart</paragraph>
200</tablecell>
201<tablecell colspan="" rowspan="">
202<paragraph role="tablecontent" id="par_id3153919" xml-lang="en-US" l10n="CHG" oldref="26">Activates the Quickstarter.<comment>now on UNIX too</comment></paragraph>
203</tablecell>
204</tablerow>
205<tablerow>
206<tablecell colspan="" rowspan="">
207<paragraph role="tablecontent" id="par_id3152479" xml-lang="en-US" l10n="U" oldref="30">-accept={UNO string}</paragraph>
208</tablecell>
209<tablecell colspan="" rowspan="">
210<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>
211<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>
212</tablecell>
213</tablerow>
214<tablerow>
215<tablecell colspan="" rowspan="">
216<paragraph role="tablecontent" id="par_id3149964" xml-lang="en-US" l10n="CHG" oldref="33">-env</paragraph>
217</tablecell>
218<tablecell colspan="" rowspan="">
219<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>
220<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>
221</tablecell>
222</tablerow>
223<tablerow>
224<tablecell colspan="" rowspan="">
225<paragraph role="tablecontent" id="par_id3159238" xml-lang="en-US" l10n="U" oldref="36">-p {filename1} {filename2} ...</paragraph>
226</tablecell>
227<tablecell colspan="" rowspan="">
228<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>
229<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>
230</tablecell>
231</tablerow>
232<tablerow>
233<tablecell colspan="" rowspan="">
234<paragraph role="tablecontent" id="par_id3150883" xml-lang="en-US" l10n="U" oldref="38">-pt {Printername} {filename1} {filename2} ...</paragraph>
235</tablecell>
236<tablecell colspan="" rowspan="">
237<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>
238<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>
239</tablecell>
240</tablerow>
241<tablerow>
242<tablecell colspan="" rowspan="">
243<paragraph role="tablecontent" id="par_id3154372" xml-lang="en-US" l10n="U" oldref="39">-o {filename}</paragraph>
244</tablecell>
245<tablecell colspan="" rowspan="">
246<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>
247</tablecell>
248</tablerow>
249<tablerow>
250<tablecell colspan="" rowspan="">
251<paragraph role="tablecontent" id="par_id3151182" xml-lang="en-US" l10n="U" oldref="54">-view {filename}</paragraph>
252</tablecell>
253<tablecell colspan="" rowspan="">
254<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>
255</tablecell>
256</tablerow>
257<tablerow>
258<tablecell colspan="" rowspan="">
259<paragraph role="tablecontent" id="par_id3166421" xml-lang="en-US" l10n="U" oldref="41">-n {filename}</paragraph>
260</tablecell>
261<tablecell colspan="" rowspan="">
262<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>
263</tablecell>
264</tablerow>
265<tablerow>
266<tablecell colspan="" rowspan="">
267<paragraph role="tablecontent" id="par_id3155126" xml-lang="en-US" l10n="U" oldref="43">-nologo</paragraph>
268</tablecell>
269<tablecell colspan="" rowspan="">
270<paragraph role="tablecontent" id="par_id3151334" xml-lang="en-US" l10n="U" oldref="44">Disables the splash screen at program start.</paragraph>
271</tablecell>
272</tablerow>
273<tablerow>
274<tablecell colspan="" rowspan="">
275<paragraph role="tablecontent" id="par_id3159171" xml-lang="en-US" l10n="U" oldref="75">-nodefault</paragraph>
276</tablecell>
277<tablecell colspan="" rowspan="">
278<paragraph role="tablecontent" id="par_id3153306" xml-lang="en-US" l10n="CHG" oldref="76">Starts without displaying anything except the splash screen.</paragraph>
279</tablecell>
280</tablerow>
281<tablerow>
282<tablecell colspan="" rowspan="">
283<paragraph role="tablecontent" id="par_id2211676" xml-lang="en-US" l10n="NEW">-nofirststartwizard</paragraph>
284</tablecell>
285<tablecell colspan="" rowspan="">
286<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>
287</tablecell>
288</tablerow>
289<tablerow>
290<tablecell colspan="" rowspan="">
291<paragraph role="tablecontent" id="par_id3153915" xml-lang="en-US" l10n="U" oldref="45">-display {display}</paragraph>
292</tablecell>
293<tablecell colspan="" rowspan="">
294<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>
295</tablecell>
296</tablerow>
297<tablerow>
298<tablecell colspan="" rowspan="">
299<paragraph role="tablecontent" id="par_id3149595" xml-lang="en-US" l10n="U" oldref="56">-headless</paragraph>
300</tablecell>
301<tablecell colspan="" rowspan="">
302<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>
303<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>
304</tablecell>
305</tablerow>
306</table>
307<comment>see i70904 for more parameters:
308-terminate_after_init
309-plugin
310-bean
311-clientdisplay
312-userid</comment>
313</section>
314</body>
315</helpdocument>
316