Tools/epm - Revision history

Drn@ecs.soton.ac.uk: /* Commands */

2023-07-15T19:17:36Z

‎Commands

Drn@ecs.soton.ac.uk: Added unlink_lib to usage instructions

2023-07-15T09:43:39Z

Added unlink_lib to usage instructions

Drn@ecs.soton.ac.uk: Added unlink_lib

2023-07-15T09:42:50Z

Added unlink_lib

Drn@ecs.soton.ac.uk: /* Commands */ Added not for --force with uninstall

2023-07-15T09:22:55Z

‎Commands: Added not for --force with uninstall

Drn@ecs.soton.ac.uk: Added rebuild command

2023-07-14T11:39:51Z

Added rebuild command

Drn@ecs.soton.ac.uk: Added command explanations with examples

2023-07-14T10:19:58Z

Added command explanations with examples

Drn@ecs.soton.ac.uk: Added tools/epm

2022-02-13T11:34:46Z

Added tools/epm

New page

{{dirs}}

'''epm''' is a command line to to manage EPMs with the following usage:
Usage:
epm *command* [options]

Where *command* is one of:

build
disable
enable
install
link_lib
list
rebuild
uninstall
unpack

Options:
--verbose
--force
--help
--man
--epm package_path
Read metadata from the epm at package_path when building.

--version
Set the version when building.

@@ Line 30: / Line 30: @@
 == Commands ==
-; build : Builds a new <PACKAGE>.epm file. Uses metadata provided by PACKAGE.epmi if provided by <code>--epm</code> flag. Uses first argument after the command as the .epm filename and remaining arguments as files that should be packaged in the EPM. E.g. <code>tools/epm build my_epm cfd.d/my_epm.pl plugins/EPrints/Screen/MyEPM.pm --epm /home/eprints/my_epm.epmi</code>
+; build : Builds a new <PACKAGE>.epm file. Uses metadata provided by <PACKAGE>.epmi if provided by <code>--epm</code> flag. Uses first argument after the command as the .epm filename and remaining arguments as files that should be packaged in the EPM. E.g. <code>tools/epm build my_epm cfd.d/my_epm.pl plugins/EPrints/Screen/MyEPM.pm --epm /home/eprints/my_epm.epmi</code>
 ; disable : Disables an EPM in a particular repository archive.  First argument is the archive ID and the second argument is the EPM to be disable. E.g. <code>tools/epm disable my_archive my_epm</code>.
 ; enable : Enables an EPM in a particular repository archive.  First argument is the archive ID and the second argument is the EPM to be enable. E.g. <code>tools/epm enable my_archive my_epm</code>
 ; install : Instalsl EPM specified within a .epm file to the repository under lib/epm/ as well as appropriate locations within lib/.  E.g. <code>tools/epm install /home/eprints/MyEPM.epm</code>
-; link_lib : Take a source directory of an EPM in lib/epm/PACKAGE and symlink to it from the correct locations in lib/.  Using <code>--force</code> flag replaces any files currently in those locations in lib/.  E.g. <code>tools/epm link_lib my_epm</code>
+; link_lib : Take a source directory of an EPM in lib/epm/<PACKAGE> and symlink to it from the correct locations in lib/.  Using <code>--force</code> flag replaces any files currently in those locations in lib/.  E.g. <code>tools/epm link_lib my_epm</code>
 ; list : List the current EPM packages installed and their versions. E.g. <code>tools/epm list</code>
-; rebuild : Rebuilds the .epm and .epmi files in lib/epm/PACKAGE based on the existing files non-epm files in that directory.  E.g.  <code>tools/epm rebuild my_epm</code>
+; rebuild : Rebuilds the .epm and .epmi files in lib/epm/<PACKAGE> based on the existing files non-epm files in that directory.  E.g.  <code>tools/epm rebuild my_epm</code>
 ; uninstall : Uninstalls specified EPM from repository including removing from lib/epm/, appropriate locations in lib/ and disabling configuration files within any archives using the EPM.  Using <code>--force</code> flag ignores EPM being enabled in an archive and any checksum mismatches. E.g. <code>tools/epm uninstall my_epm</code>
-; unlink_lib : Unlink files linked into lib/ from a source directory of an EPM in lib/epm/PACKAGE.  I.e. reverses link_lib.  Not available until EPrints 3.4.6+. Cannot be run even with <code>--force</code> if EPM is enabled in an archive. E.g. <code>tools/epm unlink_lib my_epm</code>
+; unlink_lib : Unlink files linked into lib/ from a source directory of an EPM in lib/epm/<PACKAGE>.  I.e. reverses link_lib.  Not available until EPrints 3.4.6+. Cannot be run even with <code>--force</code> if EPM is enabled in an archive. E.g. <code>tools/epm unlink_lib my_epm</code>
 ; unpack : Unpacks the files in a .epm file and writes them to the current directory.  E.g. <code>tools/epm unpack /home/eprints/MyEPM.epm</code>

@@ Line 37: / Line 37: @@
 ; rebuild : Rebuilds the .epm and .epmi files in lib/epm/PACKAGE based on the existing files non-epm files in that directory.  E.g.  <code>tools/epm rebuild my_epm</code>
 ; uninstall : Uninstalls specified EPM from repository including removing from lib/epm/, appropriate locations in lib/ and disabling configuration files within any archives using the EPM.  Using <code>--force</code> flag ignores EPM being enabled in an archive and any checksum mismatches. E.g. <code>tools/epm uninstall my_epm</code>
 ; unpack : Unpacks the files in a .epm file and writes them to the current directory.  E.g. <code>tools/epm unpack /home/eprints/MyEPM.epm</code>

@@ Line 36: / Line 36: @@
 ; list : List the current EPM packages installed and their versions. E.g. <code>tools/epm list</code>
 ; rebuild : Rebuilds the .epm and .epmi files in lib/epm/PACKAGE based on the existing files non-epm files in that directory.  E.g.  <code>tools/epm rebuild my_epm</code>
-; uninstall : Uninstalls specified EPM from repository including removing from lib/epm/, appropriate locations in lib/ and disabling configuration files within any archives using the EPM. E.g. <code>tools/epm uninstall my_epm</code>
+; uninstall : Uninstalls specified EPM from repository including removing from lib/epm/, appropriate locations in lib/ and disabling configuration files within any archives using the EPM.  Using <code>--force</code> flag ignores EPM being enabled in an archive and any checksum mismatches. E.g. <code>tools/epm uninstall my_epm</code>
 ; unpack : Unpacks the files in a .epm file and writes them to the current directory.  E.g. <code>tools/epm unpack /home/eprints/MyEPM.epm</code>

@@ Line 35: / Line 35: @@
 ; link_lib : Take a source directory of an EPM in lib/epm/PACKAGE and symlink to it from the correct locations in lib/.  Using <code>--force</code> flag replaces any files currently in those locations in lib/.  E.g. <code>tools/epm link_lib my_epm</code>
 ; list : List the current EPM packages installed and their versions. E.g. <code>tools/epm list</code>
 ; uninstall : Uninstalls specified EPM from repository including removing from lib/epm/, appropriate locations in lib/ and disabling configuration files within any archives using the EPM. E.g. <code>tools/epm uninstall my_epm</code>
 ; unpack : Unpacks the files in a .epm file and writes them to the current directory.  E.g. <code>tools/epm unpack /home/eprints/MyEPM.epm</code>

← Older revision		Revision as of 10:19, 14 July 2023
Line 27:		Line 27:
	--version		--version
	Set the version when building.		Set the version when building.
		+
		+	== Commands ==
		+	; build : Builds a new <PACKAGE>.epm file. Uses metadata provided by PACKAGE.epmi if provided by <code>--epm</code> flag. Uses first argument after the command as the .epm filename and remaining arguments as files that should be packaged in the EPM. E.g. <code>tools/epm build my_epm cfd.d/my_epm.pl plugins/EPrints/Screen/MyEPM.pm --epm /home/eprints/my_epm.epmi</code>
		+	; disable : Disables an EPM in a particular repository archive. First argument is the archive ID and the second argument is the EPM to be disable. E.g. <code>tools/epm disable my_archive my_epm</code>.
		+	; enable : Enables an EPM in a particular repository archive. First argument is the archive ID and the second argument is the EPM to be enable. E.g. <code>tools/epm enable my_archive my_epm</code>
		+	; install : Instalsl EPM specified within a .epm file to the repository under lib/epm/ as well as appropriate locations within lib/. E.g. <code>tools/epm install /home/eprints/MyEPM.epm</code>
		+	; link_lib : Take a source directory of an EPM in lib/epm/PACKAGE and symlink to it from the correct locations in lib/. Using <code>--force</code> flag replaces any files currently in those locations in lib/. E.g. <code>tools/epm link_lib my_epm</code>
		+	; list : List the current EPM packages installed and their versions. E.g. <code>tools/epm list</code>
		+	; uninstall : Uninstalls specified EPM from repository including removing from lib/epm/, appropriate locations in lib/ and disabling configuration files within any archives using the EPM. E.g. <code>tools/epm uninstall my_epm</code>
		+	; unpack : Unpacks the files in a .epm file and writes them to the current directory. E.g. <code>tools/epm unpack /home/eprints/MyEPM.epm</code>