Difference between revisions of "Documentation/Administration Guide/Using Package Manager"

From Apache OpenOffice Wiki
Jump to: navigation, search
 
(48 intermediate revisions by 3 users not shown)
Line 1: Line 1:
{{DISPLAYTITLE:Using the {{OOo}} Package Manager}}
 
 
{{Documentation/AdminGuideTOC/v2
 
{{Documentation/AdminGuideTOC/v2
 
|ShowPrevNext=block
 
|ShowPrevNext=block
Line 6: Line 5:
 
|NextPage=Documentation/Administration_Guide/Adding_Template_Files
 
|NextPage=Documentation/Administration_Guide/Adding_Template_Files
 
|PrevPage=Documentation/Administration_Guide/Using_Custom_Macros_and_Libraries
 
|PrevPage=Documentation/Administration_Guide/Using_Custom_Macros_and_Libraries
}}
+
}}  
 +
{{DISPLAYTITLE:{{OOo}} Extension Manager}}
 +
__NOTOC__
 +
You can use the {{OOo}} Extension Manager to add, remove, disable, enable, or export {{OOo}} extensions. For example, you can use the Extension Manager to add or remove the following types of extensions:
 +
* Configuration Data
 +
* Configuration Libraries
 +
* Extensions
 +
* Universal Network Objects (UNO) components<br>These components represent compiled software packages. UNO is the interface-based component model for {{OOo}}. For more information on this model, go to the [http://udk.openoffice.org UNO Development Kit project web site].
  
You can use the {{OOo}} Package Manager to add, to remove, to disable, to enable, and to export {{OOo}} packages. For example, you can use the Package Manager to add or to remove the following types of packages:
+
{{Note|You cannot manage XSLT filters, language modules, or palettes with the Extension Manager.}}
  
* '''{{OOo}} Basic libraries'''
+
You can manage extensions from a dialog box or from the command-line.
* '''{{OOo}} dialog libraries'''
+
* '''Universal Network Objects (UNO) components'''<br>These components represent compiled software packages. UNO is the interface-based component model for {{OOo}}. For more information on this model, go to the [http://udk.openoffice.org UNO Development Kit project web site].
+
* '''Menu configuration data'''
+
* '''Package bundles'''<br>A package bundle is a <tt>*.zip</tt> archive file that contains one of more packages.
+
  
{{Documentation/Note|You cannot manage XSLT filters, language modules, or palettes with the Package Manager.}}
+
Extensions can be installed so they are available to either the current user (single user installation), or to all users (shared user installation).
  
You can manage packages from a dialog box or a command-line.
+
== Single user install ==
 +
To install an extension for the current user, open the Extension Manager dialog box from the '''Tools''' menu in any {{OOo}} program and install the extension.  The extension will be installed and be immediately available to the current user.  The extension will not be available to other users on this computer.
  
==Using the Package Manager Dialog Box==
+
== Shared user install ==
 +
To install an extension for all users (shared user installation), you must install the extension as root or Administrator.  You can do this from the command line (recommended), or from the OpenOffice.org Extension manager.
  
You can open the Package Manager dialog box from the '''Tools''' menu in any {{OOo}} Program. However, to add packages for all  
+
=== Using the Extension manager===
users of a {{OOo}} installation, you need to open the Package Manager dialog box from the command-line.
+
To install an extension for all users on a single machine, you can use the OpenOffice.org Extension manager.  You must be running OpenOffice.org as root or Administrator.
  
===To Add a Package With the Package Manager Dialog Box===
+
Open the Extension Manager dialog box from the '''Tools''' menu in any {{OOo}} program and install the extension.  You will be asked "For whom do you want to install the extension?".  Select '''For all users''' and complete the install. The extension will be installed and be immediately available to all users.
 +
 
 +
===Using the command line===
 +
To install an extension for all users, you can use the <tt>unopkg add --shared</tt> command-line application.  You must have root or Administrator privileges.
 +
 
 +
==== To Add an Extension for All Users ====
  
 
# Become root.
 
# Become root.
#* In UNIX and Linux, open a terminal, and type <tt>su</tt>
+
#* In UNIX, Linux and OSX, open a terminal window, type <tt>su</tt> and enter your root user password.
#* In Windows, open a Command Prompt.
+
#* In Windows XP, open a command prompt.
# Change to the <tt>&lt;{{OOo}} installation directory&gt;/{{OOo}}2/program</tt> directory.
+
#* In Windows Vista and Windows 7, right-click the icon for the Command Prompt and select Run as Administrator.
# Type <tt>unopkg gui</tt><br>The Package Manager dialog box opens.
+
# Change to the <tt>''install-dir''/program</tt> directory.
# In the list of packages, select the package category that you want to add the package to.
+
# Type <tt>unopkg add --shared ''package-name''</tt>.
# Click the '''Add''' button.
+
# Locate the package that you want to add, and then click the '''Open''' button.
+
  
===To Remove a Package With the Package Manager Dialog Box===
+
====To Remove an Extension for All Users ====
  
 
# Become root.
 
# Become root.
#* In UNIX and Linux, open a terminal, and type <tt>su</tt>
+
#* In UNIX, Linux,and OSX, open a terminal window, and type <tt>su</tt>.
#* In Windows, open a Command Prompt.
+
#* In Windows XP, open a command prompt.
# Change to the <tt> &lt;{{OOo}} installation directory&gt;/{{OOo}}2/program</tt> directory.
+
#* In Windows Vista and Windows 7, right-click on the icon for the Command Prompt and select Run as Administrator.
# Type <tt>unopkg gui</tt><br>The Package Manager dialog box opens.
+
# Change to the <tt>''install-dir''/program</tt> directory.
# In the list of packages, select the package that you want to remove.
+
# Type <tt>unopkg remove ''package-name''</tt>.
# Click the '''Remove''' button.
+
  
 +
==Using the <tt>unopkg</tt> Command to Manage Extensions==
  
==Using the <tt>unopkg</tt> Command to Manage Packages==
+
You can manage packages from the command line. The syntax for the <tt>unopkg</tt> command is:
  
You can manage packages from the command line. The syntax for the <tt>unopkg</tt> command is as follows:
+
unopkg add {-v, -f, --log-file, --shared} extension-path
 +
        remove {-v, -f, --log-file, --shared} extension-name
 +
        list {-v, -f, --log-file, --shared} extension-name
 +
        reinstall {-v, -f, --log-file, --shared}
 +
        gui
 +
        -V
 +
        -h
  
unopkg add {v, f, log-file, shared} package-path | remove {v, f, log-file, shared} package-name <br>| list {v, f, log-file, shared} package-name | reinstall {v, f, log-file, shared} | gui | -V | -h
+
;<tt>add</tt>:Adds extensions to an {{OOo}} installation.
<br>
+
;<tt>remove</tt>:Removes extensions from an {{OOo}} installation.
;<tt>add</tt>:Adds packages to a {{OOo}} installation.
+
;<tt>list</tt>:Displays information about the deployed extensions.
;<tt>remove</tt>:Removes packages from a {{OOo}} installation.
+
;<tt>reinstall</tt>:Reinstalls the deployed extensions.
;<tt>list</tt>:Displays information about the deployed packages.
+
;<tt>gui</tt>:Opens the Extension Manager dialog box.
;<tt>reinstall</tt>:Reinstalls the deployed packages.
+
;<tt>gui</tt>:Opens the Package Manager dialog box.
+
 
;<tt>–V, – –version</tt>:Displays the version information for the <tt>unopkg</tt> command.
 
;<tt>–V, – –version</tt>:Displays the version information for the <tt>unopkg</tt> command.
 
;<tt>–h, – –help</tt>:Displays the help for the <tt>unopkg</tt> command.
 
;<tt>–h, – –help</tt>:Displays the help for the <tt>unopkg</tt> command.
 
;<tt>-v, --verbose</tt>:Runs the command in verbose mode.
 
;<tt>-v, --verbose</tt>:Runs the command in verbose mode.
;<tt>-f, --force</tt>:Overwrites existing packages that have the same names.
+
;<tt>-f, --force</tt>:Overwrites existing extensions that have the same names.
;<tt>--log-file &lt;filename&gt;</tt>:Creates a log file. The default file name path for the log file is <tt>&lt;cache-dir&gt;/log.txt</tt>
+
;<tt>--log-file ''filename''</tt>:Creates a log file. The default file name path for the log file is <tt>''cache-dir''/log.txt</tt>
 
;<tt>--shared</tt>:Expert feature: operate on shared installation deployment context; run only when no concurrent processes are running
 
;<tt>--shared</tt>:Expert feature: operate on shared installation deployment context; run only when no concurrent processes are running
  
 +
{{InterWiki Languages AdminGuide|articletitle=Documentation/Administration Guide/Using Package Manager}}
 
{{PDL1}}
 
{{PDL1}}

Latest revision as of 20:09, 2 July 2018


You can use the Apache OpenOffice Extension Manager to add, remove, disable, enable, or export Apache OpenOffice extensions. For example, you can use the Extension Manager to add or remove the following types of extensions:

  • Configuration Data
  • Configuration Libraries
  • Extensions
  • Universal Network Objects (UNO) components
    These components represent compiled software packages. UNO is the interface-based component model for Apache OpenOffice. For more information on this model, go to the UNO Development Kit project web site.
Documentation note.png You cannot manage XSLT filters, language modules, or palettes with the Extension Manager.

You can manage extensions from a dialog box or from the command-line.

Extensions can be installed so they are available to either the current user (single user installation), or to all users (shared user installation).

Single user install

To install an extension for the current user, open the Extension Manager dialog box from the Tools menu in any Apache OpenOffice program and install the extension. The extension will be installed and be immediately available to the current user. The extension will not be available to other users on this computer.

Shared user install

To install an extension for all users (shared user installation), you must install the extension as root or Administrator. You can do this from the command line (recommended), or from the OpenOffice.org Extension manager.

Using the Extension manager

To install an extension for all users on a single machine, you can use the OpenOffice.org Extension manager. You must be running OpenOffice.org as root or Administrator.

Open the Extension Manager dialog box from the Tools menu in any Apache OpenOffice program and install the extension. You will be asked "For whom do you want to install the extension?". Select For all users and complete the install. The extension will be installed and be immediately available to all users.

Using the command line

To install an extension for all users, you can use the unopkg add --shared command-line application. You must have root or Administrator privileges.

To Add an Extension for All Users

  1. Become root.
    • In UNIX, Linux and OSX, open a terminal window, type su and enter your root user password.
    • In Windows XP, open a command prompt.
    • In Windows Vista and Windows 7, right-click the icon for the Command Prompt and select Run as Administrator.
  2. Change to the install-dir/program directory.
  3. Type unopkg add --shared package-name.

To Remove an Extension for All Users

  1. Become root.
    • In UNIX, Linux,and OSX, open a terminal window, and type su.
    • In Windows XP, open a command prompt.
    • In Windows Vista and Windows 7, right-click on the icon for the Command Prompt and select Run as Administrator.
  2. Change to the install-dir/program directory.
  3. Type unopkg remove package-name.

Using the unopkg Command to Manage Extensions

You can manage packages from the command line. The syntax for the unopkg command is:

unopkg add {-v, -f, --log-file, --shared} extension-path
       remove {-v, -f, --log-file, --shared} extension-name
       list {-v, -f, --log-file, --shared} extension-name
       reinstall {-v, -f, --log-file, --shared}
       gui
       -V
       -h
add
Adds extensions to an Apache OpenOffice installation.
remove
Removes extensions from an Apache OpenOffice installation.
list
Displays information about the deployed extensions.
reinstall
Reinstalls the deployed extensions.
gui
Opens the Extension Manager dialog box.
–V, – –version
Displays the version information for the unopkg command.
–h, – –help
Displays the help for the unopkg command.
-v, --verbose
Runs the command in verbose mode.
-f, --force
Overwrites existing extensions that have the same names.
--log-file filename
Creates a log file. The default file name path for the log file is cache-dir/log.txt
--shared
Expert feature: operate on shared installation deployment context; run only when no concurrent processes are running
Content on this page is licensed under the Public Documentation License (PDL).
Personal tools
In other languages