Seth Woolley's Man Viewer

aeuconf(5) - aeuconf - user configuration file - man 5 aeuconf

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

aeuconf(5)                                                          aeuconf(5)



NAME
       aeuconf - user configuration file(1,n)

SYNOPSIS
       $AEGIS_FLAGS
       $HOME/.aegisrc
       /aegisrc
       /aegisrc

DESCRIPTION
       A  user configuration file(1,n) is used to hold user defaults.  This file(1,n) is
       created and edited by the user.  This file(1,n) is only ever read(2,n,1 builtins) by , it is
       never written.

       The  sources  of user preferences are scanned in(1,8) the order given above.
       Earlier sources have higher priority.

   AEGIS_FLAGS
       This environment variable has the same format.  It is read(2,n,1 builtins)  first,  and
       over-rides  the  .rc file(1,n) contents.  This is intended to be used within
       the tests distributed with aegis, but can also be of  use  within  some
       shell scripts.  It contains session specific preferences.

   $HOME/.aegisrc
       This file(1,n) contains user specific preferences.

   /aegisrc
       This file(1,n) contains architecture-neutral preferences.

   /aegisrc
       This file(1,n) contains architecture-specific preferences.

CONTENTS
       The file(1,n) contains the following fields:

       default_development_directory = string(3,n);
               The  pathname  of  where  to place new development directories.
               The pathname may be relative, in(1,8) which case it is  relative  to
               $HOME.   The  default  is  the  field  of  the same name in(1,8) the
               project attributes, or $HOME neither is set.

       default_project_directory = string(3,n);
               The pathname of where to place new  project  directories.   The
               pathname may be relative.  If this path is relative, it is rel-
               ative to $HOME.  The default is $HOME.

       delete_file_preference = (no_keep, interactive, keep);
               All of the commands which delete files will consult this  field
               to  determine  if(3,n)  the  file(1,n)  should  be  deleted.  Defaults to
               no_keep if(3,n) not set.

       default_project_name = string(3,n);
               The name of a project.

       default_change_number = integer;
               The number of a change.

       Please   note   that   the   default_project_name   field    and    the
       default_change_number  field  are  unrelated.  Specifying both does not
       mean that single change within that single project, they  have  nothing
       to do with each other.

       diff_preference = (automatic_merge, no_merge, only_merge);
               The aed(1) command will consult this field to determine what to
               do:

               no_merge
                       means only diff the files, even if(3,n)  some  have  out  of
                       date versions.

               only_merge
                       means  merge(1,8) those files with out of date versions, and
                       do not do anything  else,  even  if(3,n)  they  need  to  be
                       diffed.

               automatic_merge
                       means  to  do  only_merge  if(3,n)  any source files require
                       merging, otherwise  do  no_merge.   It  never  combines
                       merges and differences in(1,8) the same pass.

               The  corresponding  command  line options to the aed(1) command
               take precedence, this field is only consulted  if(3,n)  you  do  not
               give  a corresponding command line argument.  Defaults to auto-
               matic_merge if(3,n) not set.

       pager_preference = (foreground, never);
               This field is consulted for listings and  help.   The  standard
               output  is  only  piped to a pager if(3,n) the command is run in(1,8) the
               foreground and the standard output is directed at a terminal.

               foreground
                       The standard output will be piped through  the  command
                       given in(1,8) the PAGER environment variable (or more if(3,n) not
                       set(7,n,1 builtins)).

               never   The standard output will not be redirected.

               This field defaults to foreground if(3,n) not set.

       persevere_preference = (all, stop);
               This field is consulted by the aet(1) command, to determine  if(3,n)
               it should run all tests, or stop after the first failure.  This
               field defaults to all if(3,n) not set.

       log_file_preference = (snuggle, append, replace, never);
               This field controls the behavior of the log file.   It  usually
               defaults  to  snuggle  if(3,n)  not  set(7,n,1 builtins), although some commands may
               default it to append.  When the log file(1,n) is in(1,8) use, the  output
               continues  to  be  sent  to the screen if(3,n) the process is in(1,8) the
               foreground and the standard output is a terminal.

               never   Do not redirect the output to a log file.

               replace Replace any log file(1,n) that is present, create a new  one
                       if(3,n) none already exists.

               append  Append  the  log  to  the end of any existing log file(1,n),
                       create a new one if(3,n) none already exists.

               snuggle Append the log to the end of any existing log  file(1,n)  if(3,n)
                       that  log  file(1,n)  was last modified less(1,3) than 30 seconds
                       ago, otherwise replace any existing log file(1,n); create  a
                       new  one  if(3,n)  none  already exists.  This option allows
                       runs of aegis commands  to  produce  a  meaningful  log
                       file.

       lock_wait_preference = (always, background, never);
               This field is consulted by all commands which wait for locks.

               always  The  "always"  setting  says  that  all commands should
                       always wait for locks.  This is the default.

               background
                       The "background" setting says that background  commands
                       should  always  wait for locks, and foreground commands
                       will not.

               never   The "never" setting says that no  command  should  ever
                       wait  for  locks.   If  the command would wait, it will
                       exit(3,n,1 builtins) with status 1.

               This user preference  can  be  over-ridden  by  the  -wait  and
               -nowait command line options.

       symbolic_link_preference = (verify(1,8), assume);
               This  field  is consulted by aeb(1) when the project configura-
               tion file(1,n) specifies create_symbolic_links_before_build as true.
               The  verification  of the links can be quite time(1,2,n) consuming; if(3,n)
               you are confident that they are already correct  (say,  from  a
               recent  build  run) you may wish to assume they are correct and
               not verify(1,8) them repeatedly.

               verify(1,8)  This setting says to always verify(1,8) the  symbolic  links
                       to the baseline.  This is the default.

               assume  This  setting  says to always assume the links are cor-
                       rect, unless there has been a recent integration.

               This user preference can be  over-ridden  by  the  -Verify_Sym-
               bolic_Links and -Assume_Symbolic_Links command line options.

       relative_filename_preference = (current, base);
               This field is consulted by most commands which accept(2,8) filenames
               on the command line.  It controls  whether  relative  filenames
               are relative to the current directory (this is the default), or
               relative to the base of the project source tree.

               current This  setting  says  to  interpret  relative  filenames
                       against the current directory.

               base    This  setting  says  to  interpret  relative  filenames
                       against the base of the source tree.

               This user preference can be over-ridden by  the  -BAse_RElative
               and -CUrrent_RElative command line options.

       email_address = string(3,n);
               This  field may be used to set(7,n,1 builtins) the preferred email address.  If
               not set(7,n,1 builtins), defaults to `whoami`@`cat /etc/mailname` if(3,n)  not  set(7,n,1 builtins),
               and   if(3,n)   /etc/mailname   exists.    Otherwise,   defaults  to
               `whoami`@`hostname` if(3,n) not set(7,n,1 builtins), which is usually  not  what  is
               required, particularly if(3,n) you are behind a firewall.

       whiteout_preference = (always, never);
               All  of  the commands which cause a change to remove files will
               consult this field to determine if(3,n) the file(1,n) should  be  have  a
               dummy   "whiteout"  file(1,n)  put  in(1,8)  the  development  directory.
               Defaults to ``always'' if(3,n) not set.

       editor_command = string(3,n);
               This command is used to edit a file(1,n), if(3,n) the  editing  is  being
               done  in(1,8)  the  background.   Defaults to the EDITOR environment
               variable if(3,n) not set(7,n,1 builtins), or "ed" if(3,n) not set.

       visual_command = string(3,n);
               This command is used to edit a file(1,n), if(3,n) the  editing  is  being
               done  in(1,8)  the  foreground.   Defaults to the VISUAL environment
               variable if(3,n) not set(7,n,1 builtins), or to the EDITOR environment  variable  if(3,n)
               not set(7,n,1 builtins), or "vi" if(3,n) not set.

       pager_command = string(3,n);
               This is the command used to paginate report and listing output.
               Defaults to the PAGER environment variable if(3,n) not  set(7,n,1 builtins),  or  to
               "more" if(3,n) not set.

SEE ALSO
       aegis(5)
                file(1,n) format syntax

       aed(1)  difference and merge(1,8) files



                               Reference Manual                     aeuconf(5)

References for this manual (incoming links)