Difference between revisions of "Bin/"

From EPrints Documentation
Jump to: navigation, search
 
(2 intermediate revisions by one other user not shown)
Line 12: Line 12:
 
** '''epindexer''' - UNIX script to start the EPrints indexer when the server reboots. Do not call directly.  
 
** '''epindexer''' - UNIX script to start the EPrints indexer when the server reboots. Do not call directly.  
 
** '''explain_sql_tables''' - Gives a brief summary of the purpose of each SQL table.
 
** '''explain_sql_tables''' - Gives a brief summary of the purpose of each SQL table.
** '''export''' - Export data from the system using an export plugin.
+
** '''[[EPrints Directory Structure/eprints3/bin/export|export]]''' - Export data from the system using an export plugin.
 
** '''generate_abstracts''' - Update all the Metadata-Summary pages. (The page for a single EPrint which links to the documents)
 
** '''generate_abstracts''' - Update all the Metadata-Summary pages. (The page for a single EPrint which links to the documents)
 
** '''generate_apacheconf''' - Update the apache configuration files.
 
** '''generate_apacheconf''' - Update the apache configuration files.
 
** '''generate_static''' - Update all the static web pages.
 
** '''generate_static''' - Update all the static web pages.
** '''generate_views''' - Update all the /view/ pages.
+
** '''[[generate_views]]''' - Update all the /view/ pages.
 
** '''import''' - Import data from a file using an import plugin.
 
** '''import''' - Import data from a file using an import plugin.
 
** '''import_subjects''' - Import the subject tree from a text file or XML file.
 
** '''import_subjects''' - Import the subject tree from a text file or XML file.
 
** '''indexer''' - This is a daemon which runs in background and indexes the words in documents, titles, abstracts etc. so that they can be searched.
 
** '''indexer''' - This is a daemon which runs in background and indexes the words in documents, titles, abstracts etc. so that they can be searched.
 +
** '''[[issues_audit]]''' - This script should be run periodically, to identify issues such as duplicate and similar titles.
 
** '''lift_embargos''' - This script should be run once a day. It removes security on documents which embargo date has passed.
 
** '''lift_embargos''' - This script should be run once a day. It removes security on documents which embargo date has passed.
 
** '''list_user_emails''' - This just outputs all the users emails as a text file. Handy for making a mailing list.
 
** '''list_user_emails''' - This just outputs all the users emails as a text file. Handy for making a mailing list.

Latest revision as of 17:37, 21 August 2015

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

Command-line tools. These are used either directly from the command line, or set to be run every so often, using cron.

Use the --man option on the command line to get more information about these tools.

eg.

# /opt/eprints3/bin/export --man
  • eprints3/bin/
    • epadmin - Perform admin tasks including creating repositories.
    • epindexer - UNIX script to start the EPrints indexer when the server reboots. Do not call directly.
    • explain_sql_tables - Gives a brief summary of the purpose of each SQL table.
    • export - Export data from the system using an export plugin.
    • generate_abstracts - Update all the Metadata-Summary pages. (The page for a single EPrint which links to the documents)
    • generate_apacheconf - Update the apache configuration files.
    • generate_static - Update all the static web pages.
    • generate_views - Update all the /view/ pages.
    • import - Import data from a file using an import plugin.
    • import_subjects - Import the subject tree from a text file or XML file.
    • indexer - This is a daemon which runs in background and indexes the words in documents, titles, abstracts etc. so that they can be searched.
    • issues_audit - This script should be run periodically, to identify issues such as duplicate and similar titles.
    • lift_embargos - This script should be run once a day. It removes security on documents which embargo date has passed.
    • list_user_emails - This just outputs all the users emails as a text file. Handy for making a mailing list.
    • make_latest - Makes a file for the specified archive with latest items. (still a bit experimental in 3.0)
    • send_alerts - This should also be run daily, weekly and monthly with the appropriate options. Sends out saved search emails.
    • startup.pl - Used by apache to load modules for mod_perl. Does not do anything useful on the command line.