IlyaSobolev/helpcenter
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases 27 Wiki Activity

Add the 'Running ONLYOFFICE Desktop Editors with parameters' article

Browse Source
This commit is contained in:
Svetlana Maleeva 2021-10-14 20:03:51 +03:00
parent 80e3752daa
commit b2adfbc5eb
15 changed files with 159 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
Web/Controls/Help/ArticlesCompleteList/Desktop/100032_flags/100032_flags.ascx Normal file
View File

@ -0,0 +1,3 @@
<%@ Control Language="C#" %>
<a class="crm-task-title sm_desktop_all_platforms sm_desktop sm_document" id="link_100032" title=""
href="<%=VirtualPathUtility.ToAbsolute("~/installation/desktop-flags.aspx")%>">Running ONLYOFFICE Desktop Editors with parameters</a>

132
Web/Controls/Help/Desktop/Documents/Common/Flags/Flags.ascx Normal file
View File

@ -0,0 +1,132 @@
<%@ Control Language="C#" Inherits="BaseContentUserControls" %>
<%@ Register Namespace="TeamLab.Controls" Assembly="__Code" TagPrefix="cc" %>
<script runat="server">
protected override void Init()
{
PageTitle = PageCaption = "Running ONLYOFFICE Desktop Editors with parameters";
MetaKeyWords = "ONLYOFFICE Desktop Editors, configuring, launch with parameters, run with parameters, debug mode";
MetaDescription = "Sometimes you might want to run ONLYOFFICE Desktop Editors for performing a specific task, e.g., creating a new file when running the app, opening an existing file for viewing only, or running the application in debug mode, etc. This can be done using command line flags..";
var guides = new GuidesModel();
(Page as BasePage).Guides = guides;
}
</script>
<div class="MainHelpCenter">
<h1 class="subHeaderFeaturesCaption Guides_Video_Captions">Running ONLYOFFICE Desktop Editors with parameters</h1>
<cc:localizecontent runat="Server" controlname="~/Controls/Help/VariousControls/Versions/DesktopEditors/DesktopEditors_Current.ascx" />
<div class="keyword_block">
<ul>
<li><cc:LocalizeContent runat="Server" ControlName="~/Controls/Help/Tags/desktop-editors/desktop-editors.ascx" /></li>
</ul>
</div>
<div class="video_ground video_trips">
<div class="video_text">
<p>Sometimes you might want to run <b>ONLYOFFICE Desktop Editors</b> for performing a specific task, e.g., creating a new file when running the app, opening an existing file for viewing only, or running the application in debug mode, etc. This can be done using command line flags.</p>
</div>
</div>
<h2 id="signature">List of available flags</h2>
<div class="block_of_step">
<div class="screen_text">
<p>Here you can find the flags which can be used when running ONLYOFFICE Desktop Editors and their short descriptions.</p>
<h5>Running Desktop Editors in debug mode</h5>
<p>This option can be used on all operating systems.</p>
<p><code>--ascdesktop-support-debug-info</code> - is used to run ONLYOFFICE Desktop Editors in debug mode with the ability to open the console. To start working in debug mode, right-click any editable field on the top toolbar (for example, font list combo) and click Inspect Element.</p>
<p><img alt="Inspect element" src="<%=VirtualPathUtility.ToAbsolute("~/images/Help/Guides/big/guide151/inspect.png")%>" /></p>
<h5>Customizing Desktop Editors window</h5>
<p>These options can be used on Linux OS.</p>
<p><code>--system-title-bar</code> - is used to run ONLYOFFICE Desktop Editors in a system window.</p>
<p><img alt="System window" src="<%=VirtualPathUtility.ToAbsolute("~/images/Help/Guides/big/guide151/system-title-bar.png")%>" /></p>
<p><code>--custom-title-bar</code> - is used to run ONLYOFFICE Desktop Editors in a standard window (not a system one). This flag is used to cancel the effect of the <code>--system-title-bar</code> flag.</p>
<p><img alt="Standard window" src="<%=VirtualPathUtility.ToAbsolute("~/images/Help/Guides/big/guide151/custom-title-bar.png")%>" /></p>
<h5>Running Desktop Editors along with opening a file in a certain mode</h5>
<p>These options can be used on Windows and Linux OS.</p>
<p><code>--review=path/to/file</code> - is used to open an existing DOCX file in the Track Changes mode without the ability to disable this mode. The XLSX and PPTX files will be opened in the viewing mode, as the track changes mode is not currently supported in spreadsheets and presentations.</p>
<p><code>--view=path/to/file</code> - is used to open an existing DOCX, XLSX, or PPTX file in the viewing mode without the ability to switch to the editing mode.</p>
<div class="notehelp">Replace <code>path/to/file</code> with an actual full path to an existing file. The file path must be enclosed in double quotes. E.g., <code>--review="C:\Users\username\Documents\Document1.docx"</code> for Windows, <code>--review="/home/username/Documents/Document1.docx"</code> for Linux<%--, <code>--review="/Users/username/Documents/Document1.docx"</code> for MacOS--%>.</div>
<h5>Running Desktop Editors as an independent process</h5>
<p>This option can be used on all operating systems.</p>
<p><code>--single-window-app</code> - is used to run the desktop editors in a new application as an independent process in case one instance of the application is already launched. If you close the first application, you’ll not see the "All the editor windows will be closed" warning and the second one will remain opened.</p>
<h5>Connecting Desktop Editors to the ONLYOFFICE cloud</h5>
<p>This option can be used on all operating systems.</p>
<p><code>--ignore-certificate-errors</code> - is used to disable the certificate validity check so that you can connect desktop editors to the ONLYOFFICE cloud in case you use a self-signed SSL certificate on your ONLYOFFICE portal.</p>
<h5>Creating new files when opening Desktop Editors</h5>
<p>These options can be used on Windows and Linux OS.</p>
<p><code>--new:word</code> - is used to run the desktop editors and create a new local DOCX file.</p>
<p><code>--new:cell</code> - is used to run the desktop editors and create a new local XLSX file.</p>
<p><code>--new:slide</code> - is used to run the desktop editors and create a new local PPTX file.</p>
</div>
</div>
<h2 id="signsignatureline">Running Desktop Editors with parameters</h2>
<div class="block_of_step">
<div class="screen_text">
<p>This process differs depending on the operating system - Windows, Linux, or Mac OS. Please choose the corresponding tab to read detailed instructions for your OS:</p>
<input type="radio" name="tabs" id="tab1" checked />
<label for="tab1">Windows</label>
<input type="radio" name="tabs" id="tab2" />
<label for="tab2">Linux</label>
<input type="radio" name="tabs" id="tab3" />
<label for="tab3">Mac OS</label>
<div class="tab content1">
<p>On Windows, there are two ways to launch the application: through the shortcut or the terminal.</p>
<p><b>Option 1.</b> Run the app through the shortcut:</p>
<ol>
<li>Right-click the application shortcut on the desktop screen.</li>
<li>Choose <b>Properties</b>.</li>
<li>Open the <b>Shortcut</b> tab.</li>
<li>In the Target field, after the path to the application, enter a space and then type the necessary flag.</li>
<li>Click the <b>Apply</b> button.
<p><img alt="Shortcut" src="<%=VirtualPathUtility.ToAbsolute("~/images/Help/Guides/big/guide151/shortcut.png")%>" /></p>
</li>
<li>You will need to provide administrator permissions to change this settings. Click <b>Continue</b>.</li>
<li>Launch the application by clicking the shortcut.</li>
</ol>
<p><b>Option 2.</b> Run the app through the terminal:</p>
<ol>
<li>Press <b>Win+R</b>.</li>
<li>In the appeared <b>Run</b> window, type cmd in the <b>Open</b> field.
<p><img alt="Run" src="<%=VirtualPathUtility.ToAbsolute("~/images/Help/Guides/big/guide151/run.png")%>" /></p>
</li>
<li>Click the <b>OK</b> button. The terminal will be opened.</li>
<li>In the command line, enter the path to the application, add a space and then type the necessary flag, for example:
<pre><code>"%ProgramFiles%\ONLYOFFICE\DesktopEditors\DesktopEditors" --ascdesktop-support-debug-info</code></pre>
<p><img alt="Terminal" src="<%=VirtualPathUtility.ToAbsolute("~/images/Help/Guides/big/guide151/windows.png")%>" /></p>
</li>
<li>Press Enter.</li>
</ol>
</div>
<div class="tab content2">
<p>On Linux, use the terminal to run ONLYOFFICE Desktop Editors using flags:</p>
<ol>
<li>Press <b>CTRL+ALT+T</b>. The terminal will be opened.</li>
<li>In the command line, enter <code>/usr/bin/desktopeditors</code>, add a space and then type the necessary flag, for example:
<pre><code>/usr/bin/desktopeditors --ascdesktop-support-debug-info</code></pre>
<p><img alt="Terminal" src="<%=VirtualPathUtility.ToAbsolute("~/images/Help/Guides/big/guide151/linux.png")%>" /></p>
</li>
<li>Press Enter.</li>
</ol>
</div>
<div class="tab content3">
<p>On Macos, use the terminal to run ONLYOFFICE Desktop Editors using flags:</p>
<ol>
<li>Press <b>Command+Space</b>.</li>
<li>In the appeared <b>Spotlight</b> window, type <b>Terminal</b> in the search line:
<p><img alt="Spotlight" src="<%=VirtualPathUtility.ToAbsolute("~/images/Help/Guides/big/guide151/macos.png")%>" /></p>
</li>
<li>Choose the <b>Terminal</b> option. The terminal will be opened.</li>
<li>In the command line, enter the path to the application, add a space and then type the necessary flag, for example:
<pre><code>"/Applications/ONLYOFFICE.app/Contents/MacOS/ONLYOFFICE" --ascdesktop-support-debug-info</code></pre>
<p><img alt="Terminal" src="<%=VirtualPathUtility.ToAbsolute("~/images/Help/Guides/big/guide151/macos2.png")%>" /></p>
</li>
<li>Press Enter.</li>
</ol>
</div>
</div>
</div>
</div>

1
Web/Controls/Help/Installation/Desktop.ascx
View File

@ -88,6 +88,7 @@
<li><cc:LocalizeContent runat="Server" ControlName="~/Controls/Help/ArticlesCompleteList/Desktop/100025_pro_features/100025_pro_features.ascx" /></li>
<li><a href="<%=VirtualPathUtility.ToAbsolute("~/installation/desktop-video-support.aspx")%>">Enable Support for Video Playback in ONLYOFFICE Desktop Editors</a></li>
<li><cc:LocalizeContent runat="Server" ControlName="~/Controls/Help/ArticlesCompleteList/Desktop/100028_uninstall_plugin/100028_uninstall_plugin.ascx" /></li>
<li><cc:LocalizeContent runat="Server" ControlName="~/Controls/Help/ArticlesCompleteList/Desktop/100032_flags/100032_flags.ascx" /></li>
</ul>
</li>
<li><h6>Connecting ONLYOFFICE Desktop Editors to a Cloud</h6>

1
Web/Controls/Help/Installation/Installation.ascx
View File

@ -782,6 +782,7 @@
<li><cc:LocalizeContent runat="Server" ControlName="~/Controls/Help/ArticlesCompleteList/Desktop/100025_pro_features/100025_pro_features.ascx" /></li>
<li><a href="<%=VirtualPathUtility.ToAbsolute("~/installation/desktop-video-support.aspx")%>">Enable Support for Video Playback in ONLYOFFICE Desktop Editors</a></li>
<li><cc:LocalizeContent runat="Server" ControlName="~/Controls/Help/ArticlesCompleteList/Desktop/100028_uninstall_plugin/100028_uninstall_plugin.ascx" /></li>
<li><cc:LocalizeContent runat="Server" ControlName="~/Controls/Help/ArticlesCompleteList/Desktop/100032_flags/100032_flags.ascx" /></li>
</ul>
</li>
<li><h6>Connecting ONLYOFFICE Desktop Editors to a Cloud</h6>

3
Web/Controls/Help/Tags/desktop-editors/desktop-editors.ascx
View File

@ -10,6 +10,7 @@
<li><cc:LocalizeContent runat="Server" ControlName="~/Controls/Help/ArticlesCompleteList/Desktop/100028_uninstall_plugin/100028_uninstall_plugin.ascx" /></li>
<li><cc:LocalizeContent runat="Server" ControlName="~/Controls/Help/ArticlesCompleteList/Desktop/100020_protect_with_password/100020_protect_with_password.ascx" /></li>
<li><cc:LocalizeContent runat="Server" ControlName="~/Controls/Help/ArticlesCompleteList/Desktop/100031_digital_signature/100031_digital_signature.ascx" /></li>
<li><cc:LocalizeContent runat="Server" ControlName="~/Controls/Help/ArticlesCompleteList/Desktop/100032_flags/100032_flags.ascx" /></li>
<li><cc:LocalizeContent runat="Server" ControlName="~/Controls/Help/ArticlesCompleteList/Video/172_private_rooms/172_private_rooms.ascx" /></li>
<li><cc:LocalizeContent runat="Server" ControlName="~/Controls/Help/ArticlesCompleteList/Video/178_pro_features/178_pro_features.ascx" /></li>
</ul>
@ -18,6 +19,6 @@
<li><cc:LocalizeContent runat="Server" ControlName="~/Controls/Help/ArticlesCompleteList/Video/186_desktop_add_plugin/186_desktop_add_plugin.ascx" /></li>
<li><cc:LocalizeContent runat="Server" ControlName="~/Controls/Help/ArticlesCompleteList/Video/187_desktop_connect_seafile/187_desktop_connect_seafile.ascx" /></li>
<li><cc:LocalizeContent runat="Server" ControlName="~/Controls/Help/ArticlesCompleteList/Video/188_digital_signature/188_digital_signature.ascx" /></li>
<li><cc:LocalizeContent runat="Server" ControlName="~/Controls/Help/ArticlesCompleteList/Video/189_desktop_password/189_desktop_password.ascx" /></li>
<li><cc:LocalizeContent runat="Server" ControlName="~/Controls/Help/ArticlesCompleteList/Video/189_desktop_password/189_desktop_password.ascx" /></li>
</ul>
</div>

BIN
Web/images/Help/Guides/big/guide151/custom-title-bar.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 7.3 KiB

BIN
Web/images/Help/Guides/big/guide151/inspect.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 41 KiB

BIN
Web/images/Help/Guides/big/guide151/linux.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 6.2 KiB

BIN
Web/images/Help/Guides/big/guide151/macos.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 9.3 KiB

BIN
Web/images/Help/Guides/big/guide151/macos2.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 5.8 KiB

BIN
Web/images/Help/Guides/big/guide151/run.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 3.9 KiB

BIN
Web/images/Help/Guides/big/guide151/shortcut.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 8.2 KiB

BIN
Web/images/Help/Guides/big/guide151/system-title-bar.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 8.5 KiB

BIN
Web/images/Help/Guides/big/guide151/windows.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 10 KiB

20
Web/installation/desktop-flags.aspx Normal file
View File

@ -0,0 +1,20 @@
<%@ Page Title="" Language="C#" MasterPageFile="~/Masters/InstallationGuides/InstallationDesktopArticles.master" %>
<%@ Register Namespace="TeamLab.Controls" Assembly="__Code" TagPrefix="cc" %>
<asp:Content ID="Content4" ContentPlaceHolderID="pagebodyidpage" runat="Server">
<body class="all_platforms desktop_editors installation_desktop">
</asp:Content>
<asp:Content ID="content3" ContentPlaceHolderID="breadstop" runat="server">
<cc:LocalizeContent runat="Server" ControlName="~/Controls/Help/VariousControls/TopControls/DesktopDocumentsTop/DesktopDocumentsTop.ascx" />
</asp:Content>
<asp:Content ID="Content1" ContentPlaceHolderID="content" runat="Server">
<cc:LocalizeContent runat="Server" ControlName="~/Controls/Help/Desktop/Documents/Common/Flags/Flags.ascx" />
</asp:Content>
<asp:Content ID="content2" ContentPlaceHolderID="leftmenupage" runat="server">
<div class="guidespage document">
<div id="SeeAlsoBlockLinks">
<div class="caption guides">
<cc:LocalizeContent runat="Server" ControlName="~/Controls/Help/ArticlesCompleteList/Desktop/100006_troubleshooting/100006_troubleshooting.ascx" />
<cc:LocalizeContent runat="Server" ControlName="~/Controls/Help/ArticlesCompleteList/Guides/040_create-portal/040_create-portal.ascx" />
</div>
</div>
</asp:Content>