The TEnv class reads config files, by default named .rootrc
.
Three types of config files are read: global, user and local files. The global file is $ROOTSYS/etc/system<name>
(or ROOTETCDIR/system<name>
) the user file is $HOME/<name>
and the local file is ./<name>
. By setting the shell variable ROOTENV_NO_HOME=1
the reading of the $HOME/<name>
resource file will be skipped. This might be useful in case the home directory resides on an auto-mounted remote file system and one wants to avoid this file system from being mounted.
The format of the .rootrc
file is similar to the .Xdefaults
format:
Option_t Option_t TPoint TPoint const char GetTextMagnitude GetFillStyle GetLineColor GetLineWidth GetMarkerStyle GetTextAlign GetTextColor GetTextSize void value
Option_t Option_t TPoint TPoint const char GetTextMagnitude GetFillStyle GetLineColor GetLineWidth GetMarkerStyle GetTextAlign GetTextColor GetTextSize void char Point_t Rectangle_t WindowAttributes_t Float_t Float_t Float_t Int_t Int_t UInt_t UInt_t Rectangle_t Int_t Int_t Window_t TString Int_t GCValues_t GetPrimarySelectionOwner GetDisplay GetScreen GetColormap GetNativeEvent const char const char dpyName wid window const char font_name cursor keysym reg const char only_if_exist regb h Point_t winding char text const char depth char const char Int_t count const char ColorStruct_t color const char Pixmap_t Pixmap_t PictureAttributes_t attr const char char ret_data h unsigned char height h Atom_t Int_t ULong_t ULong_t unsigned char prop_list Atom_t Atom_t Atom_t Time_t type
Where <SystemName>
is either Unix, WinNT, MacOS or Vms, <RootName>
the name as given in the TApplication ctor (or "RootApp" in case no explicit TApplication derived object was created), <ProgName>
the current program name and <name>
the resource name, with optionally a type specification. <value>
can be either a string, an integer, a float/double or a boolean with the values TRUE, FALSE, ON, OFF, YES, NO, OK, NOT. Booleans will be returned as an integer 0 or 1. The options [+] allows the concatenation of values to the same resource name.
E.g.:
Unix.Rint.Root.DynamicPath: .:$(ROOTSYS)/lib:~/lib
*.Root.ObjStat: 1
void Debug(Int_t level, const char *fmt,...)
<SystemName>
and <ProgName>
or <RootName>
may be the wildcard "*". A # in the first column starts comment line.
Note that the environment variables (like $ROOTSYS) need to be surrounded in parentheses in order to be expanded.
For the currently defined resources (and their default values) see $ROOTSYS/etc/system.rootrc
.
Note that the .rootrc config files contain the config for all ROOT based applications.
To add new entries to a TEnv:
env.SetValue("myname","value");
The TEnv class reads config files, by default named .rootrc.
All new entries will be saved in the file corresponding to the first SaveLevel() command. If Save() is used, new entries go into the local file by default.
Definition at line 124 of file TEnv.h.
|
| TEnv (const char *name="") |
| Create a resource table and read the (possibly) three resource files, i.e. $ROOTSYS/etc/system<name> (or ROOTETCDIR/system<name> ), $HOME/<name> and $PWD/<name> .
|
|
virtual | ~TEnv () |
| Delete the resource table.
|
|
Bool_t | Defined (const char *name) const |
|
virtual const char * | GetRcName () const |
|
THashList * | GetTable () const |
|
virtual const char * | GetValue (const char *name, const char *dflt) const |
| Returns the character value for a named resource.
|
|
virtual Double_t | GetValue (const char *name, Double_t dflt) const |
| Returns the double value for a resource.
|
|
virtual Int_t | GetValue (const char *name, Int_t dflt) const |
| Returns the integer value for a resource.
|
|
Bool_t | IgnoreDuplicates (Bool_t ignore) |
| If set to true, no warnings in case of duplicates are issued.
|
|
TClass * | IsA () const override |
|
virtual TEnvRec * | Lookup (const char *n) const |
| Loop over all resource records and return the one with name.
|
|
void | Print (Option_t *option="") const override |
| Print all resources or the global, user or local resources separately.
|
|
virtual void | PrintEnv (EEnvLevel level=kEnvAll) const |
| Print all resources for a certain level (global, user, local, changed).
|
|
virtual Int_t | ReadFile (const char *fname, EEnvLevel level) |
| Read and parse the resource file for a certain level.
|
|
virtual void | Save () |
| Write the resource files for each level.
|
|
virtual void | SaveLevel (EEnvLevel level) |
| Write the resource file for a certain level.
|
|
virtual void | SetRcName (const char *name) |
|
virtual void | SetValue (const char *name, const char *value, EEnvLevel level=kEnvChange, const char *type=nullptr) |
| Set the value of a resource or create a new resource.
|
|
virtual void | SetValue (const char *name, Double_t value) |
| Set or create a double resource value.
|
|
virtual void | SetValue (const char *name, EEnvLevel level=kEnvChange) |
| Set the value of a resource or create a new resource.
|
|
virtual void | SetValue (const char *name, Int_t value) |
| Set or create an integer resource value.
|
|
void | Streamer (TBuffer &) override |
| Stream an object of class TObject.
|
|
void | StreamerNVirtual (TBuffer &ClassDef_StreamerNVirtual_b) |
|
virtual Int_t | WriteFile (const char *fname, EEnvLevel level=kEnvAll) |
| Write resource records to file fname for a certain level.
|
|
| TObject () |
| TObject constructor.
|
|
| TObject (const TObject &object) |
| TObject copy ctor.
|
|
virtual | ~TObject () |
| TObject destructor.
|
|
void | AbstractMethod (const char *method) const |
| Use this method to implement an "abstract" method that you don't want to leave purely abstract.
|
|
virtual void | AppendPad (Option_t *option="") |
| Append graphics object to current pad.
|
|
virtual void | Browse (TBrowser *b) |
| Browse object. May be overridden for another default action.
|
|
ULong_t | CheckedHash () |
| Check and record whether this class has a consistent Hash/RecursiveRemove setup (*) and then return the regular Hash value for this object.
|
|
virtual const char * | ClassName () const |
| Returns name of class to which the object belongs.
|
|
virtual void | Clear (Option_t *="") |
|
virtual TObject * | Clone (const char *newname="") const |
| Make a clone of an object using the Streamer facility.
|
|
virtual Int_t | Compare (const TObject *obj) const |
| Compare abstract method.
|
|
virtual void | Copy (TObject &object) const |
| Copy this to obj.
|
|
virtual void | Delete (Option_t *option="") |
| Delete this object.
|
|
virtual Int_t | DistancetoPrimitive (Int_t px, Int_t py) |
| Computes distance from point (px,py) to the object.
|
|
virtual void | Draw (Option_t *option="") |
| Default Draw method for all objects.
|
|
virtual void | DrawClass () const |
| Draw class inheritance tree of the class to which this object belongs.
|
|
virtual TObject * | DrawClone (Option_t *option="") const |
| Draw a clone of this object in the current selected pad with: gROOT->SetSelectedPad(c1) .
|
|
virtual void | Dump () const |
| Dump contents of object on stdout.
|
|
virtual void | Error (const char *method, const char *msgfmt,...) const |
| Issue error message.
|
|
virtual void | Execute (const char *method, const char *params, Int_t *error=nullptr) |
| Execute method on this object with the given parameter string, e.g.
|
|
virtual void | Execute (TMethod *method, TObjArray *params, Int_t *error=nullptr) |
| Execute method on this object with parameters stored in the TObjArray.
|
|
virtual void | ExecuteEvent (Int_t event, Int_t px, Int_t py) |
| Execute action corresponding to an event at (px,py).
|
|
virtual void | Fatal (const char *method, const char *msgfmt,...) const |
| Issue fatal error message.
|
|
virtual TObject * | FindObject (const char *name) const |
| Must be redefined in derived classes.
|
|
virtual TObject * | FindObject (const TObject *obj) const |
| Must be redefined in derived classes.
|
|
virtual Option_t * | GetDrawOption () const |
| Get option used by the graphics system to draw this object.
|
|
virtual const char * | GetIconName () const |
| Returns mime type name of object.
|
|
virtual const char * | GetName () const |
| Returns name of object.
|
|
virtual char * | GetObjectInfo (Int_t px, Int_t py) const |
| Returns string containing info about the object at position (px,py).
|
|
virtual Option_t * | GetOption () const |
|
virtual const char * | GetTitle () const |
| Returns title of object.
|
|
virtual UInt_t | GetUniqueID () const |
| Return the unique object id.
|
|
virtual Bool_t | HandleTimer (TTimer *timer) |
| Execute action in response of a timer timing out.
|
|
virtual ULong_t | Hash () const |
| Return hash value for this object.
|
|
Bool_t | HasInconsistentHash () const |
| Return true is the type of this object is known to have an inconsistent setup for Hash and RecursiveRemove (i.e.
|
|
virtual void | Info (const char *method, const char *msgfmt,...) const |
| Issue info message.
|
|
virtual Bool_t | InheritsFrom (const char *classname) const |
| Returns kTRUE if object inherits from class "classname".
|
|
virtual Bool_t | InheritsFrom (const TClass *cl) const |
| Returns kTRUE if object inherits from TClass cl.
|
|
virtual void | Inspect () const |
| Dump contents of this object in a graphics canvas.
|
|
void | InvertBit (UInt_t f) |
|
Bool_t | IsDestructed () const |
| IsDestructed.
|
|
virtual Bool_t | IsEqual (const TObject *obj) const |
| Default equal comparison (objects are equal if they have the same address in memory).
|
|
virtual Bool_t | IsFolder () const |
| Returns kTRUE in case object contains browsable objects (like containers or lists of other objects).
|
|
R__ALWAYS_INLINE Bool_t | IsOnHeap () const |
|
virtual Bool_t | IsSortable () const |
|
R__ALWAYS_INLINE Bool_t | IsZombie () const |
|
virtual void | ls (Option_t *option="") const |
| The ls function lists the contents of a class on stdout.
|
|
void | MayNotUse (const char *method) const |
| Use this method to signal that a method (defined in a base class) may not be called in a derived class (in principle against good design since a child class should not provide less functionality than its parent, however, sometimes it is necessary).
|
|
virtual Bool_t | Notify () |
| This method must be overridden to handle object notification (the base implementation is no-op).
|
|
void | Obsolete (const char *method, const char *asOfVers, const char *removedFromVers) const |
| Use this method to declare a method obsolete.
|
|
void | operator delete (void *ptr) |
| Operator delete.
|
|
void | operator delete (void *ptr, void *vp) |
| Only called by placement new when throwing an exception.
|
|
void | operator delete[] (void *ptr) |
| Operator delete [].
|
|
void | operator delete[] (void *ptr, void *vp) |
| Only called by placement new[] when throwing an exception.
|
|
void * | operator new (size_t sz) |
|
void * | operator new (size_t sz, void *vp) |
|
void * | operator new[] (size_t sz) |
|
void * | operator new[] (size_t sz, void *vp) |
|
TObject & | operator= (const TObject &rhs) |
| TObject assignment operator.
|
|
virtual void | Paint (Option_t *option="") |
| This method must be overridden if a class wants to paint itself.
|
|
virtual void | Pop () |
| Pop on object drawn in a pad to the top of the display list.
|
|
virtual Int_t | Read (const char *name) |
| Read contents of object with specified name from the current directory.
|
|
virtual void | RecursiveRemove (TObject *obj) |
| Recursively remove this object from a list.
|
|
void | ResetBit (UInt_t f) |
|
virtual void | SaveAs (const char *filename="", Option_t *option="") const |
| Save this object in the file specified by filename.
|
|
virtual void | SavePrimitive (std::ostream &out, Option_t *option="") |
| Save a primitive as a C++ statement(s) on output stream "out".
|
|
void | SetBit (UInt_t f) |
|
void | SetBit (UInt_t f, Bool_t set) |
| Set or unset the user status bits as specified in f.
|
|
virtual void | SetDrawOption (Option_t *option="") |
| Set drawing option for object.
|
|
virtual void | SetUniqueID (UInt_t uid) |
| Set the unique object id.
|
|
void | StreamerNVirtual (TBuffer &ClassDef_StreamerNVirtual_b) |
|
virtual void | SysError (const char *method, const char *msgfmt,...) const |
| Issue system error message.
|
|
R__ALWAYS_INLINE Bool_t | TestBit (UInt_t f) const |
|
Int_t | TestBits (UInt_t f) const |
|
virtual void | UseCurrentStyle () |
| Set current style settings in this object This function is called when either TCanvas::UseCurrentStyle or TROOT::ForceStyle have been invoked.
|
|
virtual void | Warning (const char *method, const char *msgfmt,...) const |
| Issue warning message.
|
|
virtual Int_t | Write (const char *name=nullptr, Int_t option=0, Int_t bufsize=0) |
| Write this object to the current directory.
|
|
virtual Int_t | Write (const char *name=nullptr, Int_t option=0, Int_t bufsize=0) const |
| Write this object to the current directory.
|
|