Difference between revisions of "Tools/epm"

From EPrints Documentation
Jump to: navigation, search
(Added tools/epm)
 
m (Commands)
 
(5 intermediate revisions by the same user not shown)
Line 15: Line 15:
 
             rebuild
 
             rebuild
 
             uninstall
 
             uninstall
 +
            unlink_lib
 
             unpack
 
             unpack
 
   
 
   
Line 27: Line 28:
 
     --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>
 +
; 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>
 +
; 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>

Latest revision as of 19:17, 15 July 2023

EPrints 3 Reference: Directory Structure - Metadata Fields - Repository Configuration - XML Config Files - XML Export Format - EPrints data structure - Core API - Data Objects

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
           unlink_lib
           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.

Commands

build 
Builds a new <PACKAGE>.epm file. Uses metadata provided by <PACKAGE>.epmi if provided by --epm 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. tools/epm build my_epm cfd.d/my_epm.pl plugins/EPrints/Screen/MyEPM.pm --epm /home/eprints/my_epm.epmi
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. tools/epm disable my_archive my_epm.
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. tools/epm enable my_archive my_epm
install 
Instalsl EPM specified within a .epm file to the repository under lib/epm/ as well as appropriate locations within lib/. E.g. tools/epm install /home/eprints/MyEPM.epm
link_lib 
Take a source directory of an EPM in lib/epm/<PACKAGE> and symlink to it from the correct locations in lib/. Using --force flag replaces any files currently in those locations in lib/. E.g. tools/epm link_lib my_epm
list 
List the current EPM packages installed and their versions. E.g. tools/epm list
rebuild 
Rebuilds the .epm and .epmi files in lib/epm/<PACKAGE> based on the existing files non-epm files in that directory. E.g. tools/epm rebuild my_epm
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 --force flag ignores EPM being enabled in an archive and any checksum mismatches. E.g. tools/epm uninstall my_epm
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 --force if EPM is enabled in an archive. E.g. tools/epm unlink_lib my_epm
unpack 
Unpacks the files in a .epm file and writes them to the current directory. E.g. tools/epm unpack /home/eprints/MyEPM.epm