en:user_advanced:script_options
no way to compare when less than two revisions
Differences
This shows you the differences between two versions of the page.
— | en:user_advanced:script_options [2023/03/13 01:46] (current) – created - external edit 127.0.0.1 | ||
---|---|---|---|
Line 1: | Line 1: | ||
+ | |||
+ | |||
+ | |||
+ | ====== Greenstone Scripts ====== | ||
+ | This is a list of Greenstone scripts, with all available options and their descriptions and value information. | ||
+ | |||
+ | To run any of these scripts, you must first setup the Greenstone environment in your terminal. To do this, | ||
+ | '' | ||
+ | |||
+ | <tabbox Greenstone3> | ||
+ | Linux/Mac | ||
+ | < | ||
+ | source gs3-setup.bash | ||
+ | </ | ||
+ | \\ | ||
+ | Windows | ||
+ | < | ||
+ | gs3-setup.bat | ||
+ | </ | ||
+ | |||
+ | <tabbox Greenstone2> | ||
+ | Linux/Mac | ||
+ | < | ||
+ | source setup.bash | ||
+ | </ | ||
+ | \\ | ||
+ | Windows | ||
+ | < | ||
+ | setup.bat | ||
+ | </ | ||
+ | </ | ||
+ | \\ | ||
+ | |||
+ | To get information on any of these scripts simply run: | ||
+ | |||
+ | < | ||
+ | perl -S <script filename> | ||
+ | </ | ||
+ | |||
+ | |||
+ | |||
+ | |||
+ | ===== mkcol.pl ===== | ||
+ | //PERL script used to create the directory structure for a new Greenstone collection.// | ||
+ | |||
+ | ^ Option | ||
+ | ^GLI^Command line^ ^ ^ | ||
+ | | **creator** |'' | ||
+ | | **optionfile** |'' | ||
+ | | **maintainer** |'' | ||
+ | | **group** |'' | ||
+ | | **gs3mode** |'' | ||
+ | | **collectdir** |'' | ||
+ | | **site** |'' | ||
+ | | **public** |'' | ||
+ | | **title** |'' | ||
+ | | **about** |'' | ||
+ | | **buildtype** |'' | ||
+ | | **infodbtype** |'' | ||
+ | | **plugin** |'' | ||
+ | | **quiet** |'' | ||
+ | | **language** |'' | ||
+ | | **win31compat** |'' | ||
+ | | //not available// |'' | ||
+ | | //not available// |'' | ||
+ | |||
+ | ====public option values==== | ||
+ | |||
+ | ^Value^Description^ | ||
+ | |true|Collection is public| | ||
+ | |false|Collection is private| | ||
+ | |||
+ | ====buildtype option values==== | ||
+ | |||
+ | ^Value^Description^ | ||
+ | |mgpp|{mkcol.buildtype.mgpp}| | ||
+ | |lucene|{mkcol.buildtype.lucene}| | ||
+ | |mg|{mkcol.buildtype.mg}| | ||
+ | |||
+ | ====infodbtype option values==== | ||
+ | |||
+ | ^Value^Description^ | ||
+ | |gdbm|{mkcol.infodbtype.gdbm}| | ||
+ | |sqlite|{mkcol.infodbtype.sqlite}| | ||
+ | |jdbm|{mkcol.infodbtype.jdbm}| | ||
+ | |mssql|{mkcol.infodbtype.mssql}| | ||
+ | |gdbm-txtgz|{mkcol.infodbtype.gdbm-txtgz}| | ||
+ | |||
+ | ====win31compat option values==== | ||
+ | |||
+ | ^Value^Description^ | ||
+ | |true|Directory name 8 characters or less| | ||
+ | |false|Directory name any length| | ||
+ | |||
+ | |||
+ | |||
+ | |||
+ | ===== downloadfrom.pl ===== | ||
+ | //Downloads files from an external server// | ||
+ | |||
+ | These are the basic options. Additional options depend on | ||
+ | the value of '' | ||
+ | |||
+ | ^ Option | ||
+ | ^GLI^Command line^ ^ ^ | ||
+ | | |'' | ||
+ | |//not available// |'' | ||
+ | |//not available// |'' | ||
+ | |**Server Information**|'' | ||
+ | |**Use proxy connection? | ||
+ | |**Proxy host**|'' | ||
+ | |**Proxy port**|'' | ||
+ | |**Proxy username**|'' | ||
+ | |**Proxy password**|'' | ||
+ | |||
+ | ==== MediaWikiDownload ==== | ||
+ | //A module for downloading from MediaWiki websites// | ||
+ | |||
+ | ^ Option | ||
+ | ^GLI^Command line^ ^ ^ | ||
+ | | **url** |'' | ||
+ | | **depth** |'' | ||
+ | | **below** |'' | ||
+ | | **within** |'' | ||
+ | | **reject_files** |'' | ||
+ | | **exclude_directories** |'' | ||
+ | |||
+ | ==== OAIDownload ==== | ||
+ | //A module for downloading from OAI repositories// | ||
+ | |||
+ | ^ Option | ||
+ | ^GLI^Command line^ ^ ^ | ||
+ | | **url** |'' | ||
+ | | **metadata_prefix** |'' | ||
+ | | **set** |'' | ||
+ | | **get_doc** |'' | ||
+ | | **get_doc_exts** |'' | ||
+ | | **max_records** |'' | ||
+ | |||
+ | ==== SRWDownload ==== | ||
+ | //A module for downloading from SRW (Search/ | ||
+ | |||
+ | ^ Option | ||
+ | ^GLI^Command line^ ^ ^ | ||
+ | | **host** |'' | ||
+ | | **port** |'' | ||
+ | | **database** |'' | ||
+ | | **find** |'' | ||
+ | | **max_records** |'' | ||
+ | |||
+ | |||
+ | ==== WebDownload ==== | ||
+ | //A module for downloading from the Internet via HTTP or FTP// | ||
+ | |||
+ | ^ Option | ||
+ | ^GLI^Command line^ ^ ^ | ||
+ | | **url** |'' | ||
+ | | **depth** |'' | ||
+ | | **below** |'' | ||
+ | | **within** |'' | ||
+ | | **html_only** |'' | ||
+ | |||
+ | ==== Z3950Download ==== | ||
+ | //A module for downloading from Z3950 repositories// | ||
+ | |||
+ | ^ Option | ||
+ | ^GLI^Command line^ ^ ^ | ||
+ | | **host** |'' | ||
+ | | **port** |'' | ||
+ | | **database** |'' | ||
+ | | **find** |'' | ||
+ | | **max_records** |'' | ||
+ | |||
+ | |||
+ | |||
+ | |||
+ | |||
+ | |||
+ | |||
+ | |||
+ | |||
+ | |||
+ | |||
+ | ===== downloadinfo.pl ===== | ||
+ | //Provides information on the options available for '' | ||
+ | |||
+ | '' | ||
+ | |||
+ | |||
+ | |||
+ | ===== explode_metadata_database.pl ===== | ||
+ | //Explode a metadata database// | ||
+ | |||
+ | |||
+ | ^ Option | ||
+ | ^GLI^Command line^ ^ ^ | ||
+ | | //not available// |'' | ||
+ | | //not available// |'' | ||
+ | | **input_encoding** |'' | ||
+ | | **metadata_set** |'' | ||
+ | | **document_field** |'' | ||
+ | | **document_prefix** |'' | ||
+ | | **document_suffix** |'' | ||
+ | | **records_per_folder** |'' | ||
+ | | //not available// |'' | ||
+ | | //not available// |'' | ||
+ | | //not available// |'' | ||
+ | | //not available// |'' | ||
+ | | //not available// |'' | ||
+ | | **verbosity** |'' | ||
+ | | //not available// |'' | ||
+ | |||
+ | ====input_encoding option values==== | ||
+ | |||
+ | ^Value^Description^ | ||
+ | |auto|Use text categorization algorithm to automatically identify the encoding of each source document. This will be slower than explicitly setting the encoding but will work where more than one encoding is used within the same collection.| | ||
+ | |ascii|Plain 7 bit ASCII. This may be a bit faster than using iso_8859_1. Beware of using this when the text may contain characters outside the plain 7 bit ASCII set though (e.g. German or French text containing accents), use iso_8859_1 instead.| | ||
+ | |utf8|Either utf8 or unicode -- automatically detected.| | ||
+ | |unicode|Just unicode.| | ||
+ | |iso_8859_6|Arabic| | ||
+ | |gb|Chinese Simplified (GB)| | ||
+ | |big5|Chinese Traditional (Big5)| | ||
+ | |koi8_r|Cyrillic| | ||
+ | |iso_8859_5|Cyrillic| | ||
+ | |koi8_u|Cyrillic (Ukrainian)| | ||
+ | |dos_437|DOS codepage 437 (US English)| | ||
+ | |dos_850|DOS codepage 850 (Latin 1)| | ||
+ | |dos_852|DOS codepage 852 (Central European)| | ||
+ | |dos_866|DOS codepage 866 (Cyrillic)| | ||
+ | |iso_8859_7|Greek| | ||
+ | |iso_8859_8|Hebrew| | ||
+ | |iscii_de|ISCII Devanagari| | ||
+ | |euc_jp|Japanese (EUC)| | ||
+ | |shift_jis|Japanese (Shift-JIS)| | ||
+ | |korean|Korean (Unified Hangul Code - i.e. a superset of EUC-KR)| | ||
+ | |iso_8859_1|Latin1 (western languages)| | ||
+ | |iso_8859_15|Latin15 (revised western)| | ||
+ | |iso_8859_2|Latin2 (central and eastern european languages)| | ||
+ | |iso_8859_3|Latin3| | ||
+ | |iso_8859_4|Latin4| | ||
+ | |iso_8859_9|Turkish| | ||
+ | |windows_1250|Windows codepage 1250 (WinLatin2)| | ||
+ | |windows_1251|Windows codepage 1251 (WinCyrillic)| | ||
+ | |windows_1252|Windows codepage 1252 (WinLatin1)| | ||
+ | |windows_1253|Windows codepage 1253 (WinGreek)| | ||
+ | |windows_1254|Windows codepage 1254 (WinTurkish)| | ||
+ | |windows_1255|Windows codepage 1255 (WinHebrew)| | ||
+ | |windows_1256|Windows codepage 1256 (WinArabic)| | ||
+ | |windows_1257|Windows codepage 1257 (WinBaltic)| | ||
+ | |windows_1258|Windows codepage 1258 (Vietnamese)| | ||
+ | |windows_874|Windows codepage 874 (Thai)| | ||
+ | |||
+ | |||
+ | |||
+ | |||
+ | |||
+ | ===== import.pl ===== | ||
+ | //PERL script used to import files into a format (GreenstoneXML or GreenstoneMETS) ready for building.// | ||
+ | |||
+ | |||
+ | ^ Option | ||
+ | ^GLI^Command line^ ^ ^ | ||
+ | | **saveas** |'' | ||
+ | | //not available// |'' | ||
+ | | //not available// |'' | ||
+ | | //not available// |'' | ||
+ | | //not available// |'' | ||
+ | | //not available// |'' | ||
+ | | //not available// |'' | ||
+ | | **faillog** |'' | ||
+ | | //not available// |'' | ||
+ | | //not available// |'' | ||
+ | | //not available// |'' | ||
+ | | //not available// |'' | ||
+ | | **maxdocs** |'' | ||
+ | | **OIDtype** |'' | ||
+ | | **OIDmetadata** |'' | ||
+ | | //not available// |'' | ||
+ | | **sortmeta** |'' | ||
+ | | **removeprefix** |'' | ||
+ | | **removesuffix** |'' | ||
+ | | **groupsize** |'' | ||
+ | | **gzip** |'' | ||
+ | | //not available// |'' | ||
+ | | **verbosity** |'' | ||
+ | | //not available// |'' | ||
+ | | //not available// |'' | ||
+ | |||
+ | ====saveas option values==== | ||
+ | |||
+ | ^Value^Description^ | ||
+ | |GreenstoneXML|Greenstone XML Archive format| | ||
+ | |GreenstoneMETS|METS format using the Greenstone profile.| | ||
+ | |||
+ | ====OIDtype option values==== | ||
+ | |||
+ | ^Value^Description^ | ||
+ | |hash|Hash the contents of the file. Document identifiers will be the same every time the collection is imported.| | ||
+ | |hash_on_full_filename|Hash on the full filename to the document within the ' | ||
+ | |assigned|Use the metadata value given by the OIDmetadata option (preceded by ' | ||
+ | |incremental|Use a simple document count. Significantly faster than " | ||
+ | |dirname|Use the parent directory name (preceded by ' | ||
+ | |full_filename|Use the full file name within the ' | ||
+ | |||
+ | |||
+ | |||
+ | |||
+ | ===== buildcol.pl ===== | ||
+ | //PERL script used to build a greenstone collection from archive documents.// | ||
+ | |||
+ | |||
+ | ^ Option | ||
+ | ^GLI^Command line^ ^ ^ | ||
+ | | **remove_empty_classifications** |'' | ||
+ | | //not available// |'' | ||
+ | | //not available// |'' | ||
+ | | //not available// |'' | ||
+ | | //not available// |'' | ||
+ | | //not available// |'' | ||
+ | | **faillog** |'' | ||
+ | | **index** |'' | ||
+ | | //not available// |'' | ||
+ | | //not available// |'' | ||
+ | | //not available// |'' | ||
+ | | **language** |'' | ||
+ | | //not available// |'' | ||
+ | | **maxnumeric** |'' | ||
+ | | **mode** |'' | ||
+ | | **no_strip_html** |'' | ||
+ | | **store_metadata_coverage** |'' | ||
+ | | **no_text** |'' | ||
+ | | **sections_index_document_metadata** |'' | ||
+ | | //not available// |'' | ||
+ | | **verbosity** |'' | ||
+ | | //not available// |'' | ||
+ | | //not available// |'' | ||
+ | | //not available// |'' | ||
+ | |||
+ | ====mode option values==== | ||
+ | |||
+ | ^Value^Description^ | ||
+ | |all|Do everything.| | ||
+ | |compress_text|Just compress the text.| | ||
+ | |build_index|Just index the text.| | ||
+ | |infodb|Just build the metadata database.| | ||
+ | |||
+ | ====sections_index_document_metadata option values==== | ||
+ | |||
+ | ^Value^Description^ | ||
+ | |never|Don' | ||
+ | |always|Add all specified document level metadata even if section level metadata of that name exists.| | ||
+ | |unless_section_metadata_exists|Only add document level metadata if no section level metadata of that name exists.| | ||
+ | |||
+ | |||
+ | ===== full-rebuild.pl ===== | ||
+ | |||
+ | This program runs '' | ||
+ | previously generated files in ' | ||
+ | the content of collection' | ||
+ | |||
+ | < | ||
+ | full-rebuild.pl [options] collection | ||
+ | </ | ||
+ | //Remember for Greenstone3 you should always include the option '' | ||
+ | |||
+ | If a minus option is shared between '' | ||
+ | such as -verbosity 5. This value will be passed to both programs. If a minus option | ||
+ | is specific to one of the programs in particular, then prefix it with | ||
+ | '' | ||
+ | |||
+ | |||
+ | ===== schedule.pl ===== | ||
+ | // | ||
+ | |||
+ | |||
+ | ^ Option | ||
+ | ^GLI^Command line^ ^ ^ | ||
+ | | **schedule** |'' | ||
+ | | **frequency** |'' | ||
+ | | **action** |'' | ||
+ | | //not available// |'' | ||
+ | | //not available// |'' | ||
+ | | //not available// |'' | ||
+ | | //not available// |'' | ||
+ | | //not available// |'' | ||
+ | | **email** |'' | ||
+ | | **toaddr** |'' | ||
+ | | **fromaddr** |'' | ||
+ | | **smtp** |'' | ||
+ | | //not available// |'' | ||
+ | | //not available// |'' | ||
+ | |||
+ | ====frequency option values==== | ||
+ | |||
+ | ^Value^Description^ | ||
+ | |hourly|Re-build every hour| | ||
+ | |daily|Re-build every day| | ||
+ | |weekly|Re-build every week| | ||
+ | |||
+ | ====action option values==== | ||
+ | |||
+ | ^Value^Description^ | ||
+ | |add|Schedule automatic re-building| | ||
+ | |update|Update existing scheduling| | ||
+ | |delete|Delete existing scheduling| | ||
+ | |||
+ | |||
+ | |||
+ | ===== export.pl ===== | ||
+ | //PERL script used to export files in a Greenstone collection to another format.// | ||
+ | |||
+ | |||
+ | ^ Option | ||
+ | ^GLI^Command line^ ^ ^ | ||
+ | | **saveas** |'' | ||
+ | | //not available// |'' | ||
+ | | //not available// |'' | ||
+ | | //not available// |'' | ||
+ | | //not available// |'' | ||
+ | | //not available// |'' | ||
+ | | //not available// |'' | ||
+ | | **faillog** |'' | ||
+ | | //not available// |'' | ||
+ | | //not available// |'' | ||
+ | | //not available// |'' | ||
+ | | //not available// |'' | ||
+ | | **maxdocs** |'' | ||
+ | | **OIDtype** |'' | ||
+ | | **OIDmetadata** |'' | ||
+ | | //not available// |'' | ||
+ | | //not available// |'' | ||
+ | | //not available// |'' | ||
+ | | **xslt_txt** |'' | ||
+ | | **xslt_mets** |'' | ||
+ | | **fedora_namespace** |'' | ||
+ | | **mapping_file** |'' | ||
+ | | **group_marc** |'' | ||
+ | | **metadata_prefix** |'' | ||
+ | | **verbosity** |'' | ||
+ | | //not available// |'' | ||
+ | | **listall** |'' | ||
+ | | //not available// |'' | ||
+ | |||
+ | ====saveas option values==== | ||
+ | |||
+ | ^Value^Description^ | ||
+ | |GreenstoneMETS|METS format using the Greenstone profile.| | ||
+ | |FedoraMETS|METS format using the Fedora profile.| | ||
+ | |MARCXML|MARC XML format (an XML version of MARC 21)| | ||
+ | |DSpace|DSpace Archive format.| | ||
+ | |||
+ | ====OIDtype option values==== | ||
+ | |||
+ | ^Value^Description^ | ||
+ | |hash|Hash the contents of the file. Document identifiers will be the same every time the collection is imported.| | ||
+ | |assigned|Use the metadata value given by the OIDmetadata option; if unspecified, | ||
+ | |incremental|Use a simple document count. Significantly faster than " | ||
+ | |dirname|Use the immediate parent directory name. There should only be one document per directory, and directory names should be unique. E.g. import/ | ||
+ | |||
+ | |||
+ | |||
+ | ===== exportcol.pl ===== | ||
+ | //PERL script used to export one or more collections to a Windows CD-ROM.// | ||
+ | |||
+ | |||
+ | ^ Option | ||
+ | ^GLI^Command line^ ^ ^ | ||
+ | | **cdname** |'' | ||
+ | | **cddir** |'' | ||
+ | | //not available// |'' | ||
+ | | **noinstall** |'' | ||
+ | | **language** |'' | ||
+ | | **out** |'' | ||
+ | | //not available// |'' | ||
+ | | //not available// |'' | ||
en/user_advanced/script_options.txt · Last modified: 2023/03/13 01:46 by 127.0.0.1