helpcontent2/source/text/shared/guide/start_parameters.xhp

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