Home       Trees       Index       Help   

Vision Egg

Package VisionEgg :: Module Configuration
[frames | no frames]

Module VisionEgg.Configuration

Load config values from environment, config file, or defaults.

Applications should not import this module directly.  Instead, 'import
VisionEgg' will result in an attribute 'VisionEgg.config', which has
the configuration options as attributes.

This module searches for configuration options from the following
places: environment variables, configuration file, generic defaults.
Environment variables take precedence over the configuration file,
which takes precedence over the generic defaults.

This module also determines the location of the Vision Egg
directories.  The VISIONEGG_SYSTEM_DIR directory is by default a
directory named 'VisionEgg' in the base python directory (found in
Python variable sys.prefix).  VISIONEGG_USER_DIR is by default
'VisionEgg' in the directory specified by the environment variable
HOME, if it exists, and os.curdir otherwise.

You can create a configuration file that contains defaults for your
system.  This should be a text file with key/value pairs.  Blank lines
and anything after the pound symbol ('#') will be treated as a
comment.  Each key/value pairs should be on its own line and in the
format 'KEY=VALUE'.  By default the file 'VisionEgg.cfg' from the
VISIONEGG_USER_DIR or VISIONEGG_SYSTEM_DIR as specified above.
However, You can specify a different filename and directory by setting
the environment variable VISIONEGG_CONFIG_FILE.
Classes
Config Holds global Vision Egg configuration information.

Function Summary
  save_settings()
Save the current values to the config file, overwriting what is there.

Variable Summary
str __author__ = 'Andrew Straw <astraw@users.sourceforge.net...
str __cvs__ = '1.40'
str __date__ = '2003/09/18 09:26:56'
str __version__ = '0.9.9'
dict defaults = {'SYNCLYNC_PRESENT': 0, 'VISIONEGG_GAMMA_FILE...
dict extra_darwin_defaults = {'VISIONEGG_DARWIN_REALTIME_COMP...

Function Details

save_settings() 

Save the current values to the config file, overwriting what is there.

Variable Details

__author__

Type:
str
Value:
'Andrew Straw <astraw@users.sourceforge.net>'

__cvs__

Type:
str
Value:
'1.40'

__date__

Type:
str
Value:
'2003/09/18 09:26:56'

__version__

Type:
str
Value:
'0.9.9'

defaults

Type:
dict
Value:
{'SYNCLYNC_PRESENT': 0,
 'VISIONEGG_ALWAYS_START_LOGGING': 0,
 'VISIONEGG_FRAMELESS_WINDOW': 0,
 'VISIONEGG_FULLSCREEN': 0,
 'VISIONEGG_GAMMA_FILE': 'custom.ve_gamma',
 'VISIONEGG_GAMMA_INVERT_BLUE': 2.1000000000000001,
 'VISIONEGG_GAMMA_INVERT_GREEN': 2.1000000000000001,
 'VISIONEGG_GAMMA_INVERT_RED': 2.1000000000000001,
...

extra_darwin_defaults

Type:
dict
Value:
{'VISIONEGG_DARWIN_CONVENTIONAL_PRIORITY': -20,
 'VISIONEGG_DARWIN_MAXPRIORITY_CONVENTIONAL_NOT_REALTIME': 1,
 'VISIONEGG_DARWIN_PTHREAD_PRIORITY': 'max',
 'VISIONEGG_DARWIN_REALTIME_COMPUTATION_DENOM': 2400,
 'VISIONEGG_DARWIN_REALTIME_CONSTRAINT_DENOM': 1200,
 'VISIONEGG_DARWIN_REALTIME_PERIOD_DENOM': 120,
 'VISIONEGG_DARWIN_REALTIME_PREEMPTIBLE': 0}

   Home       Trees       Index       Help   

Vision Egg

Generated by Epydoc 2.0 on Fri Sep 19 18:29:39 2003 http://epydoc.sf.net