Differences

This shows you the differences between two versions of the page.

--- vufind2:command_line_utilities [2015/12/14 17:10] – [import controller] demiankatz
+++ administration:command_line_utilities [2019/12/17 20:54] – [util controller] demiankatz
@@ Line 11: / Line 11: @@
 In VuFind 2.4 or newer, the most consistent way to run command line tools is to run them through Zend Framework directly using the application's index.php script.
-The "PHP scripts in directory" approach to command line utilities was designed for backward compatibility with the structure of VuFind 1.x. However, VuFind 2.x's use of Zend Framework 2 allows a route-based approach where all commands can be invoked through a single endpoint -- the application's index.php script.
+The "PHP scripts in directory" approach to command line utilities was designed for backward compatibility with the structure of early VuFind releases. However, the introduction of Zend Framework in VuFind 2 allowed a route-based approach where all commands can be invoked through a single endpoint -- the application's index.php script.
 <code>
@@ Line 41: / 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.
-==== generator controller ====
+==== compile controller ====
-The generator controller (introduced in release 2.4) contains code generation tools to help automate common VuFind customization tasks. It is documented in more detail on the [[development:code_generators|code generators]] page.
+The compile controller contains the [[administration:performance#theme_compiler|theme compiler]] that was introduced in VuFind 4.1.
+==== generate controller ====
+The generate controller (introduced in release 2.4) contains code generation tools to help automate common VuFind customization tasks. It is documented in more detail on the [[development:code_generators|code generators]] page.
 ==== harvest controller ====
@@ Line 69: / Line 73: @@
 Actions:
+  * addusingtemplate \\ Create a new string by combining one or more existing strings using a template.
   * copystring \\ Copy one language string to another in all of the language files.
   * delete \\ Delete a language string from all of the language files.
   * normalize \\ Normalize (sort/deduplicate/tidy) a directory of language files.
+==== scheduledsearch controller ====
+The scheduledsearch controller is used for tasks related to VuFind's [[configuration:email_alerts|Email Alerts]] functionality.
+Actions:
+  * notify \\ Send out new notification emails, as needed.
 ==== util controller ====
@@ Line 79: / Line 92: @@
 Actions:
+  * cleanup_record_cache \\ Clean out the [[configuration:record_caching|record cache]], when used
   * commit \\ Commit the Solr index.
   * createHierarchyTrees \\ Populate the hierarchy cache when using [[indexing:hierarchies_and_collections|hierarchies and collections]].
   * cssBuilder \\ Compile LESS files into CSS within all themes.
   * dedupe \\ Remove duplicate lines from a text file.
-  * deletes \\ Remove all of the records in a specified MARC file from the Solr index.
+  * deletes \\ Remove all of the records in a specified MARC or text file from the Solr index.
+  * expire_auth_hashes \\ Clean up expired authentication hashes (generated by Email [[configuration:authentication|authentication method]]).
+  * expire_external_sessions \\ Clean up the external_sessions database table, when used.
   * expire_searches \\ Remove unwanted saved searches from the database.
   * expire_sessions \\ Remove old session data from the database.
   * index_reserves \\ Build a Solr index for course reserves.
+  * lint_marc \\ Check a MARC file for errors.
   * optimize \\ Optimize the Solr index.
   * sitemap \\ Generate a sitemap for use with search engines.
   * suppressed \\ Delete all currently suppressed catalog records from the Solr index.
+  * switch_db_hash \\ Change the password hashing algorithm in the database and configuration.
 ---- struct data ----
 ----