Logo ROOT   6.12/07
Reference Guide
CommandLineOptionsHelp.h
Go to the documentation of this file.
1 /* @(#)root/base:$Id$ */
2 
3 /*************************************************************************
4  * Copyright (C) 1995-2017, Rene Brun and Fons Rademakers. *
5  * All rights reserved. *
6  * *
7  * For the licensing terms see $ROOTSYS/LICENSE. *
8  * For the list of contributors see $ROOTSYS/README/CREDITS. *
9  *************************************************************************/
10 
11 #ifndef ROOT_CommandLineOptionsHelp
12 #define ROOT_CommandLineOptionsHelp
13 
14 
15 //////////////////////////////////////////////////////////////////////////
16 // //
17 // CommandLineOptionsHelp //
18 // //
19 // Help text displayed by TApplication and rootx.cxx. //
20 // //
21 //////////////////////////////////////////////////////////////////////////
22 
23 /// Help for command line options.
24 ///
25 /// - b : run in batch mode without graphics
26 /// - x : exit on exception
27 /// - e expression: request execution of the given C++ expression.
28 /// - n : do not execute logon and logoff macros as specified in .rootrc
29 /// - q : exit after processing command line macro files
30 /// - l : do not show splash screen
31 ///
32 /// The last three options are only relevant in conjunction with TRint.
33 /// The following help and info arguments are supported:
34 ///
35 /// - ? : print usage
36 /// - h : print usage
37 /// - -help : print usage
38 /// - config : print ./configure options
39 /// - memstat : run with memory usage monitoring
40 ///
41 /// In addition to the above options the arguments that are not options,
42 /// i.e. they don't start with - or + are treated as follows (and also removed
43 /// from the argument array):
44 ///
45 /// - `<dir>` is considered the desired working directory and available
46 /// via WorkingDirectory(), if more than one dir is specified the
47 /// first one will prevail
48 /// - `<file>` if the file exists its added to the InputFiles() list
49 /// - `<file>.root` are considered ROOT files and added to the InputFiles() list,
50 /// the file may be a remote file url
51 /// - `<macro>.C` are considered ROOT macros and also added to the InputFiles() list
52 ///
53 /// In TRint we set the working directory to the `<dir>`, the ROOT files are
54 /// connected, and the macros are executed. If your main TApplication is not
55 /// TRint you have to decide yourself what to do with these options.
56 /// All specified arguments (also the ones removed) can always be retrieved
57 /// via the TApplication::Argv() method.
58 
59 constexpr static const char kCommandLineOptionsHelp[] = R"RAW(
60 Usage: %s [-l] [-b] [-n] [-q] [dir] [[file:]data.root] [file1.C ... fileN.C]
61 Options:
62  -b : run in batch mode without graphics
63  -x : exit on exception
64  -e expression: request execution of the given C++ expression
65  -n : do not execute logon and logoff macros as specified in .rootrc
66  -q : exit after processing command line macro files
67  -l : do not show splash screen
68  -t : enable thread-safety and implicit multi-threading (IMT)
69  --notebook : execute ROOT notebook
70  dir : if dir is a valid directory cd to it before executing
71 
72  -? : print usage
73  -h : print usage
74  --help : print usage
75  -config : print ./configure options
76  -memstat : run with memory usage monitoring
77 
78 )RAW";
79 
80 #endif
static constexpr const char kCommandLineOptionsHelp[]
Help for command line options.