SCRIBE(8)

NAME
scribe - tracks, adds and removes grimoires

SYNOPSIS
scribe <action> [<options>]

EXAMPLE
To update all grimoires, type

    scribe update

To add the z-rejected and games grimoires, type

    scribe add z-rejected games

DESCRIPTION
scribe is part of the sorcery source-code package management suite. Scribe is a utility for controlling the grimoires in your codex, and the spells in your grimoires.

NAMES
We refer to a package as a "spell". Spells of the same area are collected in "sections". A collection of sections is a "grimoire". On your box, you can have several grimoires, we call the collection of them the "codex".

Games and binary packages for example are in their own grimoire, see http://wiki.sourcemage.org/index.php?page=Codex

OPTIONS
Note that options can be abbreviated to any unambiguous shorter form, e.g. scribe a is the same as scribe add.

Also, scribe update can be abbreviated as scribe u even though unlocalize has the same first letter.

  add <grimoire> [from <url>] [...]
This will add the specified grimoire(s) to your codex. Optionally, you can give an url to get it from. Scribe can use tarballs or rsync. For the official tarball and rsync urls run scribe help.

  remove <grimoire>
will remove the specified grimoire from your codex.

  update [<grimoire> [from <url>]]
will update the specified grimoire, if none is specified, all are updated. You can also give an url here (see "scribe help" for the official urls).

  fix <grimoire>
This will prompt you for the download URL of the specified grimoire in order to "repair" it. The same can be done with

    scribe update <grimoire> from <url>.

However, "fix" might get more functions in the future.

  reindex [<grimoire>]
This recreates the index files, of all grimoires or of the specified one. The index files are a sorcery mechanism to speed up spell lookups.

Always run scribe reindex whenever you add/remove spells! Otherwise, strange things will happen!

  reindex-keyword [<grimoire>]
This recreates the keyword index files, of all grimoires or of the specified one. The keyword indexes come pre-packaged with the grimoire, so this step is optional. Its also a bit slower than regular reindexing. Run this on any local grimoire you may have so that you can do keyword based lookups.

  index
shows a list of grimoires and locations where you have them installed.

  set <grim1> <grim2>
this will put grim1 just before grim2. Use this if there's spells in both grimoires and you want those from grim1 to be used first.

Note that you can use scribbler(8) for purposes like these too.

  swap <grim1> <grim2>
This will swap grim1 and grim2 in the grimoire list. You can use this if you don't like the order of your grimoires.

  localize <grimoire>
This marks a grimoire as local, which means that scribe will not attempt to update it.

  unlocalize <grimoire>
The opposite of localize. Removes the local mark.

ADVANCED USAGE
To add the grimoire waldo from http://zyzzy/waldo.tar.bz2, you would run

    scribe add waldo from http://zyzzy/waldo.tar.bz2

It should be noted that the source url listed above can be any url sorcery has a handler for. Currently they are

http, ftp, https, rsync, svn, cvs, file (local file), dir (local directory)

GRIMOIRE NAMES
Grimoires are internally represented by the full path to them. They can be uniquely described on the command line by listing the name and however many subdirectories are needed to form a unique name.

For example you may have two grimoires:

/var/lib/sorcery/codex/stable

and

/root/grimoires/stable

These can be uniquely identified with codex/stable and grimoires/stable

If just stable was specified it would match the first of the two grimoires listed in scribe index.

AUTHOR
The Source Mage GNU Linux Team <http://www.sourcemage.org>

REPORTING BUGS
Report bugs to bugzilla <http://bugs.sourcemage.org>

SEE ALSO
alter(8), cast(8), cleanse(8), dispel(8), gaze(1), grimoire(5), scribbler(8), sorcery(8), sorcery_config(5), summon(8)

WARRANTY
This is free software with ABSOLUTELY NO WARRANTY