Bin/: Difference between revisions

Latest revision as of 12:48, 5 March 2022

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/
- check_xapian - Checks whether eprints have been properly indexed by Xapian.
- epadmin - Perform admin tasks including creating repositories.
- epindexer - UNIX script to start the EPrints indexer when the server reboots. Do not call directly.
- 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_sitemap - Update sitemap.xml. Useful for improving Google indexing.
- 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.
- junit_tests - Runs unit test against the EPrints repository software but with Junit output that has better compability with Jenkins for Continuous Integration (CI).
- lift_embargos - This script should be run once a day. It removes security on documents which embargo date has passed.
- 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.
- toolbox - Various tools to manage a repository from the command line.
- unit_tests - Runs unit test against the EPrints repository software.

@@ Line 1: / Line 1: @@
+{{dirs}}
 Command-line tools. These are used either directly from the command line, or set to be run every so often, using cron.
@@ Line 6: / Line 8: @@
   # /opt/eprints3/bin/export --man
-*eprints3/bin/
+*[[EPrints_Directory_Structure/eprints3|eprints3]]/bin/
-** '''epadmin''' - Perform admin tasks including creating repositories.
+** '''[[API:bin/check_xapian|check_xapian]]''' - Checks whether eprints have been properly indexed by Xapian.
+** '''[[API:bin/epadmin|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.
+** '''[[API:bin/export|export]]''' - Export data from the system using an export plugin.
-** '''export''' - Export data from the system using an export plugin.
+** '''[[API:bin/generate_abstracts|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)
+** '''[[API:bin/generate_apacheconf|generate_apacheconf]]''' - Update the apache configuration files.
-** '''generate_apacheconf''' - Update the apache configuration files.
+** '''[[API:bin/generate_sitemap|generate_sitemap]]''' - Update sitemap.xml.  Useful for improving Google indexing.
-** '''generate_static''' - Update all the static web pages.
+** '''[[API:bin/generate_static|generate_static]]''' - Update all the static web pages.
-** '''generate_views''' - Update all the /view/ pages.
+** '''[[API:bin/generate_views|generate_views]]''' - Update all the /view/ pages.
-** '''import''' - Import data from a file using an import plugin.
+** '''[[API:bin/import|import]]''' - Import data from a file using an import plugin.
-** '''import_subjects''' - Import the subject tree from a text file or XML file.
+** '''[[API:bin/import_subjects|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.
+** '''[[API:bin/indexer|indexer]]''' - This is a daemon which runs in background and indexes the words in documents, titles, abstracts etc. so that they can be searched.
-** '''lift_embargos''' - This script should be run once a day. It removes security on documents which embargo date has passed.
+** '''[[API:bin/issues_audit|issues_audit]]''' - This script should be run periodically, to identify issues such as duplicate and similar titles.
-** '''list_user_emails''' - This just outputs all the users emails as a text file. Handy for making a mailing list.
+** '''junit_tests''' - Runs unit test against the EPrints repository software but with Junit output that has better compability with Jenkins for Continuous Integration (CI).
-** '''make_latest''' - Makes a file for the specified archive with latest items. (still a bit experimental in 3.0)
+** '''[[API:bin/lift_embargos|lift_embargos]]''' - This script should be run once a day. It removes security on documents which embargo date has passed.
-** '''send_alerts''' - This should also be run daily, weekly and monthly with the appropriate options. Sends out saved search emails.
+** '''[[API:bin/send_alerts|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.
+** '''[[API:bin/toolbox|toolbox]]''' - Various tools to manage a repository from the command line.
+** '''unit_tests''' - Runs unit test against the EPrints repository software.