Seth Woolley's Man Viewer

sorcery_config(5) - sorcery configuration, sorcery configuration - reference on sorcery's configuration options - man 5 sorcery_config

([section] manual, -k keyword, -K [section] search, -f whatis)
man plain no title

SORCERY_CONFIG(5)                File Formats                SORCERY_CONFIG(5)



NAME
       sorcery configuration - reference on sorcery's configuration options

DESCRIPTION
       The sorcery scripts can be configured by a variety of options, best set(7,n,1 builtins)
       using the sorcery command. The configuration files determine which fea-
       tures the sorcery source-based package management system should use and
       how it should behave.

SUMMARY
       The default configuration files  are  found  under  /etc/sorcery.   Any
       local versions of these files are found under /etc/sorcery/local.  Many
       of the default config(1,5) files can  be  overridden  by  a  local  version.
       /etc/sorcery/local also contains spell configurations.

WARNING
       You  should  not  modify  any  files directly in(1,8) /etc/sorcery. They set(7,n,1 builtins)
       vital defaults and paths.  They will also be overwritten by every  sor-
       cery  update(7,n)  you  run.  Therefore, you should only modify the files in(1,8)
       /etc/sorcery/local.  Normally, using sorcery to modify them should work
       fine.   Keep  in(1,8)  mind  that if(3,n) you manually change an option line to a
       complicated expression or add lines to a config(1,5) file(1,n), the next time(1,2,n) you
       edit the file(1,n) using sorcery your changes will most likely be lost.

MISC GLOBAL FILES
       This section describes the files in(1,8) /etc/sorcery.

       accounts

              contains  information for sorcery on what spell needs which user
              to exist and his GIDs.

       groups

              contains the names for those groups.

       version(1,3,5)

              contains the current version(1,3,5) of sorcery.

       internal_version

              contains 0. No discernible use.

       dialogrc

              contains the options for dialog(1,3,n), the menu(3x,n,n tk_menuSetFocus) program sorcery  uses.

       licenses/

              directory  containing the licenses of all spells in(1,8) the grimoire
              (except some in(1,8) z-rejected)

       mirror/

              directory containing lists of mirrors  for  the  sorcery  mirror
              configuration.

GLOBAL CONFIG FILES
       to be done

LOCAL MISC FILES
       todo

LOCAL CONFIG FILES
       todo

FEATURE CONFIG OPTIONS
       ARCHIVE

              This enables a very useful feature to make sorcery create a com-
              pressed .tar of all files installed by a  spell.  If  the  spell
              breaks  for  some  reason, it can be used to resurrect the spell
              without the need to recompile it.

              Use dispel -d <spell> <version(1,3,5)> to resurrect from  cache.   cast
              <spell>  will  also  do  this,  but only when the version(1,3,5) hasn't
              changed.

              Turning this feature off will save a good amount of space (a few
              hundred  megs on a desktop system), however, it will make recov-
              ering a lot harder.

       AUTOFIX

              This will make sorcery run  a  cleanse  --fix  after  a  sorcery
              upgrade, to check if(3,n) any became broken by the update.

       AUTOPRUNE

              This  will make sorcery remove old logs, sources and caches on a
              sorcery upgrade.

       CCACHE

              This will create a cache of compiled files for  spells,  slowing
              down  the  first  compile  but speeding up upgrades by detecting
              which files have not changed. This will also consume  some  disk
              space on /var.

       COLOR

              If  you have this on, you will have colorized messages.  Turning
              this off will get you back to black and white.

       CONFIG_LOC

              This makes sorcery ask "do you want to add -- options to  ./con-
              figure".   This enables you to add your custom options. However,
              you cannot remove the spell's default config(1,5) options.

       GATHER_DOCS

              With this option enabled, sorcery will copy any documentation it
              finds in(1,8) the source to /usr/share/doc/<spell>.

       MAIL_REPORTS

              This option will run "mail(1,8)" to send(2,n) the compile logs (the output
              of a cast) to the email set(7,n,1 builtins) in(1,8) "Email of Sorcerer" in(1,8) the Option
              menu.

       PRESERVE

              This  option  will make dispel not dispel modified config(1,5) files.
              Turning this option off will cause  dispel  to  rename(1,2,n)  them  to
              <file(1,n)>.YYYYMMDD.

              Note  that  a  dispel  is  usually  run  just  before a spell is
              installed, so turning this off will  replace  old  config(1,5)  files
              with defaults, too.

       SUSTAIN

              This  option  will  keep  dispel from dispelling spells that are
              vital for sorcery to run. Note that this can be temporally over-
              ridden by the --nosustain option for dispel, so there is no real
              reason to turn this off.

       TMPFS

              This will make sorcery create a tmpfs (ramdisk) for the  sources
              for  faster  compilation. Note that the filesystem cache usually
              keeps much-used files in(1,8) RAM anyway, so it is questionable  that
              a speed increase really is achieved.

       VIEW_REPORTS

              This  will  prompt  you at the end of a cast if(3,n) want to view the
              compile log.

       VOYEUR

              This will filter(1,3x,3x curs_util) out all the compile-time messages.  While  this
              makes  the  compile nicer to look(1,8,3 Search::Dict) at, you won't get a "hey, it's
              doing something" feeling.

              NOTE: This option might also keep spell and sorcery queries from
              reaching you.  If you have this off and a spell fails for myste-
              rious reasons, try cast -V on <spell> to find out what's happen-
              ing.

       REAP

              Turning this option off will keep sorcery from removing files in(1,8)
              a dispel.  This kind of takes the purpose out of dispelling, and
              might cause strange behavior in(1,8) an upgrade when the files aren't
              overwritten for some reason (e.g. they moved).

              This can also  be  turned  off  temporarily  with  the  --noreap
              option,  so again, there is no real reason to have this one off.

       NET_SELECT

              This feature will use the "netselect" command to find which  one
              of the mirrors set(7,n,1 builtins) for a spell has the lowest ping and therefore
              (hopefully) the highest bandwidth. Note  that  except  for  very
              large  source  files,  this test may take longer than the actual
              download.

       CLEAN_SOURCE

              With this off,  sorcery  will  leave  the  source  directory  in(1,8)
              /usr/src  if(3,n)  the  spell  fails, so you can figure out what went
              wrong.  If you don't find yourself doing that,  it  is  safe  to
              turn this off.  It will make for an uncluttered /usr/src.

       CROSS_INSTALL

              This  will make sorcery attempt to build the spell for a differ-
              ent architecture.

              NOTE: This is not really supported yet. We are working  on  get-
              ting  this  to  work, but right now it is not recommended to use
              this option.

       SET_TERM_TITLE

              This will make cast set(7,n,1 builtins) the terminal/screen title if(3,n) run  in(1,8)  an
              xterm/rxvt(ouR XVT) [rxvt] (1,ouR XVT) [urxvtc] (1,ouR XVT) [urxvtd] (1,ouR XVT) [wterm] (1)/screen.

   STORE_CONF_LOG
       This  will  add  the config.log of the build to the compile log sorcery
       keeps.  The config.log is an extensive output  of  what  was  done  and
       detected during the run of ./configure. Helpful for debugging.

INSTALL_ROOT
       This  section will describe the options connected with install_rooting,
       which is installing a spell to a different location.

   INSTALL_ROOT
       This option describes where the spell's files should be  installed  to.
       Note  that this is the root of that dir, so that they will probably end
       up in(1,8) $INSTALL_ROOT/usr. Should not end in(1,8) a "/".

       Note to grimoire writers: The default, when spells should be  installed
       in(1,8)   default   locations,   is   "".   Take  care,  therefore,  to  use
       "${INSTALL_ROOT}/".

   STATE_ROOT
       This option specifies the root where installed state information should
       go.  This is currently /etc/sorcery/local/depends, /var/log/sorcery and
       /var/state/sorcery.

       If you are installing a different configuration, this  should  probably
       point  somewhere  else too so you don't get the two installations mixed
       up.

   TRACK_ROOT
       This option specifies how files should be recorded in(1,8) the install logs.
       $INSTALL_ROOT  in(1,8)  the  logs  will  be  replaced  by this.  For a cross
       install, for example, this should be "/".

       Note to grimoire writers: If you for some reason (symlinks  etc.)  have
       to  know  where the file(1,n) will be residing when it will be executed, use
       this variable instead of INSTALL_ROOT.

   INSTALL_CACHE
       This option specifies directly where  to  dump  the  cache  files  (the
       .tar.bz2 of all the files the spell installed).  This is not a root, so
       the directory you specify will be the one the files end up in.

AUTHOR
       Original version(1,3,5) by Karsten Behrmann.

       Maintained    by     the     Source     Mage     GNU     Linux     Team
       (http://www.sourcemage.org)

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

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


WARRANTY
       This is free software with ABSOLUTELY NO WARRANTY




Source Mage GNU Linux           September 2004               SORCERY_CONFIG(5)

References for this manual (incoming links)