Add Copyright / License information + Documentation
[rarslave2.git] / rsutil / globals.py
1 #!/usr/bin/env python
2 # vim: set ts=4 sts=4 sw=4 textwidth=92:
3
4 """
5 Module which holds global variables needed throughout the rarslave project.
6 """
7
8 __author__    = "Ira W. Snyder (devel@irasnyder.com)"
9 __copyright__ = "Copyright (c) 2006,2007 Ira W. Snyder (devel@irasnyder.com)"
10 __license__   = "GNU GPL v2 (or, at your option, any later version)"
11
12 #    globals.py -- global variable storage for the rarslave project
13 #
14 #    Copyright (C) 2006,2007  Ira W. Snyder (devel@irasnyder.com)
15 #
16 #    This program is free software; you can redistribute it and/or modify
17 #    it under the terms of the GNU General Public License as published by
18 #    the Free Software Foundation; either version 2 of the License, or
19 #    (at your option) any later version.
20 #
21 #    This program is distributed in the hope that it will be useful,
22 #    but WITHOUT ANY WARRANTY; without even the implied warranty of
23 #    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
24 #    GNU General Public License for more details.
25 #
26 #    You should have received a copy of the GNU General Public License
27 #    along with this program; if not, write to the Free Software
28 #    Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
29
30 import rsutil.config
31
32 # I know that this sucks majorly, but I kinda need it to keep things
33 # sane in the code. I don't /want/ to have to keep passing the config
34 # and options around all the time.
35
36 # This will hold the configuration from the configuration file. This should
37 # only be used to hold statically, non-runtime alterable content.
38 config  = rsutil.config.config ()
39
40 # This will hold the configuration from the command-line options. You should
41 # probably be using this to get values in most cases. It takes its defaults
42 # from the configuration file.
43 options = None
44