Warning: This page has not been updated in over over a year and may be outdated or deprecated.
administration:command_line_utilities
Differences
This shows you the differences between two versions of the page.
Both sides previous revisionPrevious revisionNext revision | Previous revisionNext revisionBoth sides next revision | ||
administration:command_line_utilities [2019/12/17 20:54] – [util controller] demiankatz | administration:command_line_utilities [2020/04/30 11:45] – [Using the Index Script] demiankatz | ||
---|---|---|---|
Line 5: | Line 5: | ||
===== Running the Tools ===== | ===== Running the Tools ===== | ||
- | The command line tools are organized into controllers | + | The command line tools are organized into categories |
- | ==== Using Zend Framework | + | ==== Using the Index Script |
- | In VuFind 2.4 or newer, the most consistent way to run command line tools is to run them through | + | In VuFind 2.4 or newer, the most consistent way to run command line tools is to run them through |
- | The "PHP scripts in directory" | + | The "PHP scripts in directory" |
< | < | ||
- | php $VUFIND_HOME/ | + | php $VUFIND_HOME/ |
</ | </ | ||
+ | |||
+ | The code was implemented using the Zend\Console package until release 7.0, when that package was deprecated and had to be replaced with Symfony\Console. Only the internals changed, so the process of running the scripts remained the same -- see the blog post [[https:// | ||
==== Using Legacy Wrapper Scripts ==== | ==== Using Legacy Wrapper Scripts ==== | ||
- | Prior to VuFind 2.4, the only way to access command line scripts was to run PHP scripts whose filenames corresponded with action names, and which were stored in directories corresponding with controller | + | Prior to VuFind 2.4, the only way to access command line scripts was to run PHP scripts whose filenames corresponded with action names, and which were stored in directories corresponding with category |
< | < | ||
- | php $VUFIND_HOME/ | + | php $VUFIND_HOME/ |
</ | </ | ||
Line 39: | Line 41: | ||
</ | </ | ||
- | Most of these actions are also summarized below, grouped by controller. However, in case this documentation falls out of date, the index.php output is always the most current way of finding all available tools. | + | Most of these actions are also summarized below, grouped by category. However, in case this documentation falls out of date, the index.php output is always the most current way of finding all available tools. |
- | ==== compile | + | ==== compile |
- | The compile | + | The compile |
- | ==== generate | + | ==== generate |
- | The generate | + | The generate |
- | ==== harvest | + | ==== harvest |
- | The harvest | + | The harvest |
Actions: | Actions: | ||
Line 58: | Line 60: | ||
* merge-marc | * merge-marc | ||
- | ==== import | + | ==== import |
- | The import | + | The import |
Actions: | Actions: | ||
Line 67: | Line 69: | ||
* webcrawl \\ Tool for populating the website index when [[indexing: | * webcrawl \\ Tool for populating the website index when [[indexing: | ||
- | ==== language | + | ==== install category ==== |
+ | |||
+ | Introduced in VuFind 7.0, the install category integrates the formerly stand-alone install.php script with VuFind' | ||
+ | |||
+ | Actions: | ||
+ | * install \\ Run the install script to set up [[development: | ||
+ | |||
+ | ==== language | ||
- | The language | + | The language |
Actions: | Actions: | ||
Line 78: | Line 87: | ||
* normalize \\ Normalize (sort/ | * normalize \\ Normalize (sort/ | ||
- | ==== scheduledsearch | + | ==== scheduledsearch |
- | The scheduledsearch | + | The scheduledsearch |
Actions: | Actions: | ||
Line 86: | Line 95: | ||
* notify \\ Send out new notification emails, as needed. | * notify \\ Send out new notification emails, as needed. | ||
- | ==== util controller | + | ==== util category |
- | The util controller | + | The util category |
Actions: | Actions: |
administration/command_line_utilities.txt · Last modified: 2023/04/20 14:53 by demiankatz