Starting the $[officename] Software With Parameters

-start parameters -command line parameters -parameters;command line -arguments in command line - -Starting the $[officename] Software With Parameters -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. -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. -Starting the $[officename] Software From the Command Line - - -Under Windows, select Run from the Windows Start menu, or open a shell under Linux, *BSD, or Mac OS X platforms. - - -Under Windows, type the following text in the Open text field and click OK. - - -Under UNIX-like systems, type the following line of text, then press Return: -{install}\program\soffice.exe {parameter} -{install}/program/soffice {parameter} - -Replace {install} with the path to your installation of the $[officename] software (for example, C:\Program Files\Office, or ~/office) -Where required, replace {parameter} with one or more of the following command line parameters. - - -Valid Command Line Parameters - - - -Parameter - - -Meaning - - - - ---help / -h / -? - - -Lists the available command line parameters in a dialog box -to the console. - - - - ---version - - -Displays the version information. - - - - ---writer - - -Starts with an empty Writer document. - - - - ---calc - - -Starts with an empty Calc document. - - - - ---draw - - -Starts with an empty Draw document. - - - - ---impress - - -Starts with an empty Impress document. - - - - ---math - - -Starts with an empty Math document. - - - - ---global - - -Starts with an empty Writer master document. - - - - ---web - - -Starts with an empty HTML document. - - - - ---show {filename.odp} - - -Starts with the Impress file {filename.odp} and starts the presentation. Enters edit mode after the presentation. - - - - ---minimized - - -Starts minimized. The splash screen is not displayed. - - - - ---invisible - - -Starts in invisible mode. -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 API. -When the $[officename] software has been started with this parameter, it can only be ended using the taskmanager (Windows) or the kill command (UNIX-like systems). -It cannot be used in conjunction with -quickstart. -More information is found in the $[officename] Developer's Guide. - - - - ---norestore - - -Disables restart and file recovery after a system crash. - - - - ---nofirststartwizard - - -Disables the Welcome Wizard. - - - - ---quickstart - - -Activates the Quickstarter.now on UNIX too - - - - ---accept={UNO string} - - -Notifies the $[officename] software that upon the creation of "UNO Acceptor Threads", a "UNO Accept String" will be used. -More information is found in the $[officename] Developer's Guide. - - - - ---unaccept={UNO string} - - -Closes an acceptor that was created with --accept={UNO string}. Use --unaccept=all to close all open acceptors. - - - - --p {filename1} {filename2} ... - - -Prints the files {filename1} {filename2} ... to the default printer and ends. The splash screen does not appear. -If the file name contains spaces, then it must be enclosed in quotation marks. - - - - ---pt {Printername} {filename1} {filename2} ... - - -Prints the files {filename1} {filename2} ... to the printer {Printername} and ends. The splash screen does not appear. -If the file name contains spaces, then it must be enclosed in quotation marks. - - - - --o {filename} - - -Opens {filename} for editing, even if it is a template. - - - - ---view {filename} - - -Creates a temporary copy of {filename} and opens it read-only. - - - - --n {filename} - - -Creates a new document using {filename} as a template. - - - - ---nologo - - -Disables the splash screen at program start. - - - - ---nodefault - - -Starts without displaying anything except the splash screen. - - - - ---nolockcheck - - -Disables check for remote instances using the installation. - - - - ---nofirststartwizard - - -Add this parameter to the program start command to suppress the Welcome Wizard.see i72749 - - - - ---display {display} - - -Sets the DISPLAY environment variable on UNIX-like platforms to the value {display}. This parameter is only supported by the start script for the $[officename] software on UNIX-like platforms. - - - - ---headless - - -Starts in "headless mode" which allows using the application without user interface. -This special mode can be used when the application is controlled by external clients via the API. - - - - ---infilter={filter} - - -Forces an input filter type, if possible. Eg. --infilter="Calc Office Open XML". - - - - ---convert-to output_file_extension[:output_filter_name] [--outdir output_dir] files - - -Batch convert files. If --outdir is not specified, then current working directory is used as output_dir.
Eg. --convert-to pdf *.doc
--convert-to pdf:writer_pdf_Export --outdir /home/user *.doc - - - - ---print-to-file [--printer-name printer_name] [--outdir output_dir] files - - -Batch print files to file. If --outdir is not specified, then current working directory is used as output_dir.
Eg. --print-to-file *.doc
--print-to-file --printer-name nasty_lowres_printer --outdir /home/user *.doc - - -

-see i70904 for more parameters: --terminate_after_init --plugin --bean --clientdisplay --userid +

+ + start parameters + command line parameters + parameters;command line + arguments in command line + + Starting $[officename] Software With Parameters + By starting $[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. + 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 $[officename] software technology. + Starting $[officename] Software From the Command Line + + + Under Windows, select Run from the Windows Start menu, or open a shell under Linux, *BSD, or Mac OS X platforms. + + + Under Windows, type the following text in the Open text field and click OK. + + + Under UNIX-like systems, type the following line of text, then press Return: + {install}\program\soffice.exe {parameter}{install}/program/soffice {parameter} + Replace {install} with the path to your installation of $[officename] software (for example, C:\Program Files\Office, or ~/office) + + + Valid Command Line Parameters + Using without special arguments + Using without any arguments opens the start center. + + + + {file} + + + Tries to open the file (files) in the components suitable for them. + + + + + {file} macro:///[Library.Module.MacroName] + + + Opens the file and applies specified macros from the file. + + +

+ Getting help and information + + + + Parameter + + + Meaning + + + + + --help / -h / -? + + + Lists the available command line parameters to the console. + + + + + --helpwriter + + + Opens $[officename] built-in or online Help on Writer. + + + + + --helpcalc + + + Opens $[officename] built-in or online Help on Calc. + + + + + --helpdraw + + + Opens $[officename] built-in or online Help on Draw. + + + + + --helpimpress + + + Opens $[officename] built-in or online Help on Impress. + + + + + --helpbase + + + Opens $[officename] built-in or online Help on Base. + + + + + --helpbasic + + + Opens $[officename] built-in or online Help on Basic scripting language. + + + + + --helpmath + + + Opens $[officename] built-in or online Help on Math. + + + + + --version + + + Shows $[officename] version and quits. + + + + + --nstemporarydirectory + + + (MacOS X sandbox only) Returns path of the temporary directory for the current user and exits. Overrides all other arguments. + + +

+ + General arguments + + + + + + + + + + + + --quickstart=[no] + + + Activates[Deactivates] the Quickstarter service. It can take only one parameter no which deativates the Quickstarter service. Without parameters this service is activated. + + + + + --nolockcheck + + + Disables check for remote instances using the installation. + + + + + --infilter={filter} + + + Forces an input filter type, if possible. For example:
--infilter="Calc Office Open XML"
--infilter="Text (encoded):UTF8,LF,,,." + + + + + --pidfile={file} + + + Store soffice.bin pid to {file}. + + + + + --display {display} + + + Sets the DISPLAY environment variable on UNIX-like platforms to the value {display}. This parameter is only supported by the start script for $[officename] software on UNIX-like platforms. + + +

+ + User/programmatic interface control + + + + + + + + + + + + --nologo + + + Disables the splash screen at program start. + + + + + --minimized + + + Starts minimized. The splash screen is not displayed. + + + + + --nodefault + + + Starts without displaying anything except the splash screen. + + + + + --invisible + + + Starts in invisible mode. + Neither the start-up logo nor the initial program window will be visible. $[officename] software can be controlled, and documents and dialogs can be controlled and opened via the API. + Using the parameter, $[officename] can only be ended using the taskmanager (Windows) or the kill command (UNIX-like systems). + It cannot be used in conjunction with --quickstart. + More information is found in $[officename] Developer's Guide. + + + + + --headless + + + Starts in "headless mode" which allows using the application without user interface. + This special mode can be used when the application is controlled by external clients via the API. + + + + + --norestore + + + Disables restart and file recovery after a system crash. + + + + + --safe-mode + + + Starts in a safe mode, i.e. starts temporarily with a fresh user profile and helps to restore a broken configuration. + + + + + --accept={UNO} + + + Notifies $[officename] software that upon the creation of "UNO Acceptor Threads", a "UNO Accept String" will be used. + UNO-URL is string the such kind uno:connection-type,params;protocol-name,params;ObjectName. + More information is found in $[officename] Developer's Guide. + + + + + --unaccept={UNO-URL} + + + Closes an acceptor that was created with --accept={UNO-URL}. Use --unaccept=all to close all open acceptors. + + + + + --language={lang} + + + Uses specified language, if language is not selected yet for UI. The lang is a tag of the language in IETF language tag. + + +

+ + Developer arguments + + + + + + + + + + + + --terminate_after_init + + + Exit after initialization complete (no documents loaded). + + + + + --eventtesting + + + Exit after loading documents. + + +

+ + New document creation arguments + The arguments create an empty document of specified kind. Only one of them may be used in one command line. If filenames are specified after an argument, then it tries to open those files in the specified component. + + + + + + + + + + + + --writer + + + Starts with an empty Writer document. + + + + + --calc + + + Starts with an empty Calc document. + + + + + --draw + + + Starts with an empty Draw document. + + + + + --impress + + + Starts with an empty Impress document. + + + + + --math + + + Starts with an empty Math document. + + + + + --global + + + Starts with an empty Writer master document. + + + + + --web + + + Starts with an empty HTML document. + + +

+ File open arguments + The arguments define how following filenames are treated. New treatment begins after the argument and ends at the next argument. The default treatment is to open documents for editing, and create new documents from document templates. + + + + + + + + + + + + -n + + + Treats following files as templates for creation of new documents. + + + + + -o + + + Opens following files for editing, regardless whether they are templates or not. + + + + + --pt {Printername} + + + Prints the following files to the printer {Printername} and ends. The splash screen does not appear. + If the file name contains spaces, then it must be enclosed in quotation marks. + If used multiple times, only last {Printername} is effective for all documents of all --pt runs. + Also, --printer-name argument of --print-to-file switch interferes with {Printername}. + + + + + -p + + + Prints following files to the default printer, after which those files are closed. The splash screen does not appear. + If the file name contains spaces, then it must be enclosed in quotation marks. + + + + + --view + + + Opens following files in viewer mode (read-only). + + + + + --show + + + Opens and starts the following presentation documents of each immediately. Files are closed after the showing. Files other than Impress documents are opened in default mode , regardless of previous mode. + + + + + --convert-to OutputFileExtension[:OutputFilterName] [--outdir output_dir] + + + Batch convert files (implies --headless). If --outdir isn't specified, then current working directory is used as output_dir. + If --convert-to is used more than once, last value of OutputFileExtension[:OutputFilterName] is effective. If --outdir is used more than once, only its last value is effective. For example: + --convert-to pdf *.doc
--convert-to pdf:writer_pdf_Export --outdir /home/user *.doc
--convert-to \"html:XHTML Writer File:UTF8\" *.doc
--convert-to \"txt:Text (encoded):UTF8\" *.doc + + + + + --print-to-file [--printer-name printer_name] [--outdir output_dir] + + + Batch print files to file. If --outdir is not specified, then current working directory is used as output_dir. + If --printer-name or --outdir used multiple times, only last value of each is effective. Also, {Printername} of --pt switch interferes with --printer-name. For example: + --print-to-file *.doc
--print-to-file --printer-name nasty_lowres_printer --outdir /home/user *.doc + + + + + --cat + + + Dump text content of the following files to console (implies --headless). Cannot be used with --convert-to. + + + + + -env:VAR[=VALUE] + + + Set a bootstrap variable. For example: to set a non-default user profile path: + -env:UserInstallation=file:///tmp/test + + +

+ Ignored switches + + + + + + + + + + + + -psn + + + Ignored (MacOS X only) + + + + + -Embedding + + + Ignored (COM+ related; Windows only) + + + + + --nofirststartwizard + + + Does nothing, accepted only for backward compatibility. + + + + + --protector {arg1} {arg2} + + + Used only in unit tests and should have two arguments. + + +

-- cgit v1.2.3