summaryrefslogtreecommitdiffstats
path: root/source/text/shared/01/packagemanager.xhp
blob: 1281912a913e886d56402dfd041e1245f10c63c5 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
<?xml version="1.0" encoding="UTF-8"?><helpdocument version="1.0">
<!--
 * This file is part of the LibreOffice project.
 *
 * This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at http://mozilla.org/MPL/2.0/.
 *
 * This file incorporates work covered by the following license notice:
 *
 *   Licensed to the Apache Software Foundation (ASF) under one or more
 *   contributor license agreements. See the NOTICE file distributed
 *   with this work for additional information regarding copyright
 *   ownership. The ASF licenses this file to you under the Apache
 *   License, Version 2.0 (the "License"); you may not use this file
 *   except in compliance with the License. You may obtain a copy of
 *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
 -->

<meta>
<topic id="textshared01packagemanagerxml" indexer="include">
<title xml-lang="en-US" id="tit">Extension Manager</title>
<filename>/text/shared/01/packagemanager.xhp</filename>
</topic>
</meta>
<body>
<section id="packagemanager">
<bookmark xml-lang="en-US" branch="index" id="bm_id2883388">
<bookmark_value>UNO components;Extension Manager</bookmark_value>
<bookmark_value>extensions;Extension Manager</bookmark_value>
<bookmark_value>packages, see extensions</bookmark_value>
</bookmark>
<bookmark xml-lang="en-US" branch="hid/desktop/ui/extensionmanager/@@nowidget@@" id="@@nowidget@@" localize="false"/>
<bookmark xml-lang="en-US" branch="hid/desktop/ui/extensionmanager/ExtensionManagerDialog" id="bm_id307931" localize="false"/>
<bookmark xml-lang="en-US" branch="hid/service:com.sun.star.deployment.ui.PackageManagerDialog" id="bm_id2198553" localize="false"/>
<paragraph id="par_idN10543" role="heading" xml-lang="en-US" level="1"><link href="text/shared/01/packagemanager.xhp">Extension Manager</link></paragraph>
<paragraph id="par_idN10553" role="paragraph" xml-lang="en-US"><ahelp hid="desktop/ui/extensionmanager/ExtensionManagerDialog">The Extension Manager adds, removes, disables, enables, and updates %PRODUCTNAME extensions.</ahelp></paragraph>
</section>
<section id="howtoget"><embed href="text/shared/00/00000406.xhp#packagemanager"/>
</section>
<paragraph id="par_idN10615" role="paragraph" xml-lang="en-US">The following are examples of %PRODUCTNAME extensions:</paragraph>
<list type="ordered">
<listitem>
<paragraph id="par_idN1061B" role="paragraph" xml-lang="en-US">UNO components (compiled software modules)</paragraph>
</listitem>
<listitem>
<paragraph id="par_idN1061F" role="paragraph" xml-lang="en-US">Configuration data (for menu commands)</paragraph>
</listitem>
<listitem>
<paragraph id="par_idN10623" role="paragraph" xml-lang="en-US">%PRODUCTNAME Basic libraries</paragraph>
</listitem>
<listitem>
<paragraph id="par_idN106E8" role="paragraph" xml-lang="en-US">%PRODUCTNAME dialog libraries</paragraph>
</listitem>
<listitem>
<paragraph id="par_idN106F5" role="paragraph" xml-lang="en-US">Extension files (*.oxt files containing one or more extensions of the above listed types)</paragraph>
</listitem>
</list>
<section id="extscope">
<paragraph id="hd_id8570513" role="heading" xml-lang="en-US" level="2">Extension Scope</paragraph>
</section>
<paragraph id="par_idN1068A" role="paragraph" xml-lang="en-US">Users with administrator or root privileges will see a dialog where they can choose to install extensions "for all users" or "only for me". Normal users without those privileges can install, remove, or modify extensions only for their own use.</paragraph>
<list type="ordered">
<listitem>
<paragraph id="par_idN10626" role="paragraph" xml-lang="en-US">A user with root or administrator privileges can install an extension as a shared extension that is available to all users. After selecting an extension, a dialog opens and asks whether to install for the current user or all users.</paragraph>
</listitem>
<listitem>
<paragraph id="par_idN1069C" role="paragraph" xml-lang="en-US">A user without root privileges can only install an extension for own usage. This is called a user extension.</paragraph>
</listitem>
</list><comment>UFI: Extension Guide needed. Until we have that guide, I'll add some more info in this file.</comment>
<paragraph id="hd_id3895382" role="heading" xml-lang="en-US" level="2">To install an extension</paragraph>
<paragraph id="par_id9143955" role="paragraph" xml-lang="en-US">An extension is available as a file with the file extension .oxt.</paragraph>
<bookmark xml-lang="en-US" branch="hid/desktop/ui/extensionmanager/getextensions" id="bm_id8800926" localize="false"/>
<paragraph id="par_id7857905" role="paragraph" xml-lang="en-US"><ahelp hid=".">You can find a collection of extensions on the Web.</ahelp> Click the "Get more extensions online" link in the Extension Manager to open your Web browser and see the <link href="https://extensions.libreoffice.org/">https://extensions.libreoffice.org/</link> page.</paragraph>
<paragraph id="hd_id5016937" role="heading" xml-lang="en-US" level="3">To install a user extension</paragraph>
<paragraph id="par_id1856440" role="paragraph" xml-lang="en-US">Do any of the following:</paragraph>
<list type="ordered">
<listitem>
<paragraph id="par_id7654347" role="paragraph" xml-lang="en-US">Double-click the <item type="literal">.oxt</item> file in your system's file browser.</paragraph>
</listitem>
<listitem>
<paragraph id="par_id5269020" role="paragraph" xml-lang="en-US">On a web page, click a hyperlink to an <item type="literal">*.oxt</item> file (if your web browser can be configured to start the Extension Manager for this file type).</paragraph>
</listitem>
<listitem>
<paragraph id="par_id8714255" role="paragraph" xml-lang="en-US">Choose <item type="menuitem">Tools - Extension Manager</item> and click <item type="menuitem">Add</item>.</paragraph>
</listitem>
</list>
<paragraph id="hd_id3734550" role="heading" xml-lang="en-US" level="4">To install a shared extension in text mode (for system administrators)</paragraph>
<list type="ordered">
<listitem>
<paragraph id="par_id4139225" role="paragraph" xml-lang="en-US">As an administrator, open a terminal or command shell.</paragraph>
</listitem>
<listitem>
<paragraph id="par_id671712" role="paragraph" xml-lang="en-US">Change to the <switchinline select="sys"><caseinline select="WIN">\
</caseinline><defaultinline>/</defaultinline></switchinline>program folder in your installation.</paragraph>
</listitem>
<listitem>
<paragraph id="par_id4163945" role="paragraph" xml-lang="en-US">Enter the following command, using the path and file name of your extension:</paragraph>
<paragraph id="par_id9581591" role="paragraph" xml-lang="en-US"><item type="literal">unopkg add --shared path_filename.oxt</item></paragraph>
</listitem>
</list>

<bookmark xml-lang="en-US" branch="hid/desktop/ui/extensionmanager/extensions" id="bm_id8800927" localize="false"/>
<paragraph id="par_idN106AD" role="paragraph" xml-lang="en-US"><ahelp hid=".">Select the extension that you want to remove, enable, or disable. For some extensions, you can also open an Options dialog.</ahelp></paragraph>

<bookmark xml-lang="en-US" branch="hid/desktop/ui/extensionmanager/addbtn" id="bm_id8800928" localize="false"/>
<paragraph id="par_idN10639" role="heading" xml-lang="en-US" level="2">Add</paragraph>
<paragraph id="par_idN106BA" role="paragraph" xml-lang="en-US"><ahelp hid="desktop/ui/extensionmanager/addbtn">Click Add to add an extension.</ahelp></paragraph>
<paragraph id="par_idN106BD" role="paragraph" xml-lang="en-US">A file dialog opens where you can select the extension that you want to add. To copy and to register the selected extension, click Open.</paragraph>

<bookmark xml-lang="en-US" branch="hid/desktop/ui/showlicensedialog/ShowLicenseDialog" id="bm_id2089297" localize="false"/>
<bookmark xml-lang="en-US" branch="hid/desktop/ui/showlicensedialog/@@nowidget@@" id="bm_id2089297" localize="false"/>
<paragraph id="par_id4856410" role="paragraph" xml-lang="en-US">An extension can show a license dialog. <ahelp hid="desktop/ui/showlicensedialog/ShowLicenseDialog">Read the license. Click the Scroll Down button to scroll down if necessary. Click Accept to continue the installation of the extension.</ahelp></paragraph><comment>insert hidden text for Show License</comment>

<bookmark xml-lang="en-US" branch="hid/desktop/ui/extensionmanager/removebtn" id="bm_id0523200810562584" localize="false"/>
<paragraph id="par_idN10643" role="heading" xml-lang="en-US" level="2">Remove</paragraph>
<paragraph id="par_idN106D1" role="paragraph" xml-lang="en-US"><ahelp hid=".">Select the extension that you want to remove, and then click Remove.</ahelp></paragraph>

<bookmark xml-lang="en-US" branch="hid/DESKTOP_HID_EXTENSION_MANAGER_LISTBOX_ENABLE" id="bm_id8800928" localize="false"/>
<paragraph id="par_idN1064D" role="heading" xml-lang="en-US" level="2">Enable</paragraph>
<paragraph id="par_idN106DE" role="paragraph" xml-lang="en-US"><ahelp hid="DESKTOP_HID_EXTENSION_MANAGER_LISTBOX_ENABLE">Select the extension that you want to enable, and then click Enable.</ahelp></paragraph>

<bookmark xml-lang="en-US" branch="hid/DESKTOP_HID_EXTENSION_MANAGER_LISTBOX_DISABLE" id="bm_id8800929" localize="false"/>
<paragraph id="par_idN10657" role="heading" xml-lang="en-US" level="2">Disable</paragraph>
<paragraph id="par_idN106EB" role="paragraph" xml-lang="en-US"><ahelp hid="DESKTOP_HID_EXTENSION_MANAGER_LISTBOX_DISABLE">Select the extension that you want to disable, and then click Disable.</ahelp></paragraph>

<bookmark xml-lang="en-US" branch="hid/desktop/ui/extensionmanager/updatebtn" id="bm_id8800930" localize="false"/>
<paragraph id="hd_id4453566" role="heading" xml-lang="en-US" level="2">Update</paragraph>
<paragraph id="par_id4129459" role="paragraph" xml-lang="en-US"><ahelp hid="desktop/ui/extensionmanager/updatebtn">Click to check for online updates of all installed extensions. To check for updates of the selected extension only, choose the Update command from the context menu. The check for availability of updates starts immediately.</ahelp> You will see the <link href="text/shared/01/extensionupdate.xhp">Extension Update</link> dialog.</paragraph>

<bookmark xml-lang="en-US" branch="hid/desktop/ui/extensionmanager/optionsbtn" id="bm_id052320081054360" localize="false"/>
<paragraph id="hd_id4921414" role="heading" xml-lang="en-US" level="2">Options</paragraph>
<paragraph id="par_id1439558" role="paragraph" xml-lang="en-US"><ahelp hid=".">Select an installed extension, then click to open the Options dialog for the extension.</ahelp></paragraph>

<paragraph id="hd_id4921415" role="heading" xml-lang="en-US" level="2">Display Extensions</paragraph>
<paragraph id="par_id1439559" role="paragraph" xml-lang="en-US">You can filter the list of displayed extensions by their <link href="text/shared/01/packagemanager.xhp#extscope">scope</link>.</paragraph>

<bookmark xml-lang="en-US" branch="hid/desktop/ui/extensionmanager/bundled" id="bm_id052320081054361" localize="false"/>
<paragraph id="par_id0103201110331828" role="heading" xml-lang="en-US" level="3">Bundled with %PRODUCTNAME</paragraph>
<paragraph id="par_id1439560" role="paragraph" xml-lang="en-US"><ahelp hid=".">Bundled extensions are installed by the system administrator using the operating system specific installer packages. These can not be installed, updated or removed here.</ahelp></paragraph>

<bookmark xml-lang="en-US" branch="hid/desktop/ui/extensionmanager/shared" id="bm_id052320081054362" localize="false"/>
<paragraph id="par_id0103201110331829" role="heading" xml-lang="en-US" level="3">Installed for all users</paragraph>
<paragraph id="par_id1439561" role="paragraph" xml-lang="en-US"><ahelp hid=".">Filter extensions available for all users of this computer.</ahelp> These can be updated or removed only with administrator or root privileges.</paragraph>

<bookmark xml-lang="en-US" branch="hid/desktop/ui/extensionmanager/user" id="bm_id052320081054363" localize="false"/>
<paragraph id="par_id0103201110331830" role="heading" xml-lang="en-US" level="3">Installed for current user</paragraph>
<paragraph id="par_id1439562" role="paragraph" xml-lang="en-US"><ahelp hid=".">Filter extensions only available for the currently logged in user.</ahelp></paragraph>

<paragraph id="par_id0103201110331832" role="paragraph" xml-lang="en-US">Some additional commands can appear in the context menu of an extension in the Extension Manager window, depending on the selected extension. You can choose to show the license text again. You can choose to exclude the extension from checking for updates or to include an excluded extension.</paragraph>
</body>
</helpdocument>