Script Index


/usr/sbin/scribe

Synopsis

scribe handles adding/updating/reindexing/etc. of grimoires

scribe


function help()

Parameters:

Description

help print horribly unhelpful helpscreen


function scribe_download_fail_error_msg()

Parameters:

Description

Common error messag when downloading a grimoire fails.


function unpackage_grimoire_tarball()

Parameters:

Description

Unpackage a grimoire tarball and make sure it worked


function sanitize_rsync_url()

Parameters:

Description

Given an rsync url, make sure it has a / on the end of it so downloading works.


function scribe_validate_tree_common()

Parameters:

Description

Validate a grimoire tree using a manifest


function scribe_add()

Parameters:

Description

scribe_add add grimoires to codex, unless they already exist usage: scribe_add grimoire [ from location] [grimoire [ from location]] ...


function scribe_add_update_worker()

Parameters:

Description

scribe_add_worker downloads a grimoire, unpacks it and adds it to the codex listing if location is not given the default is used


function scribe_fix()

Parameters:

Description

scribe_fix frontend to metadata fixing


function scribe_fix_metadata()

Parameters:

Description

scribe_fix_metadata fixes the metadata on a grimoire based on user input


function scribe_index()

Parameters:

Description

scribe_index Display installed grimoires


function scribe_localize()

Parameters:

Description

scribe_localize Set grimoires "local" so scribe update ignores them


function scribe_localize_sub()

Parameters:

Description

scribe_localize_sub Adjust grimoires localization state


function scribe_reindex()

Parameters:

Description

scribe_reindex Update the spell index for grimoires


function scribe_reindex_keyword()

Parameters:

Description

scribe_reindex_keyword Recreate the keyword index, this is slow in comparison to normal reindexing.


function scribe_reindex_version()

Parameters:

Description

scribe_reindex_version Recreate the version index TODO: merge scribe_reindex_* functions?


function scribe_remove()

Parameters:

Description

scribe_remove remove a grimoire from the codex


function scribe_set()

Parameters:

Description

scribe_set Set grimoire1 before grimoire2, do this by removing grimoire1, then finding the position of grimoire2 and then use codex_add_grimoire on grimore1 with overwrite off


function scribe_swap()

Parameters:

Description

scribe_swap switch grimoire1 and grimoire2 in the grimoire ordering do this by finding their positions, using the overwrite feature of codex_add_grimoire


function scribe_update()

Parameters:

Description

scribe_update updates all installed grimoires, or just those passed in as params


function scribe_unlocalize()

Parameters:

Description

scribe_localize Removes a grimoire's "local" state so scribe update will update them


function find_function()

Parameters:

Description

find_function take the command line and figure out what the user wants to do


function main()

Parameters:

Description

main start the ride.