DIRACGrid · atsareg · Feb 3, 2021 · Nov 19, 2020 · Nov 24, 2020 · Nov 24, 2020
@@ -11,7 +11,7 @@
 - Sends report for performed operation to the VO administrator
 
 The agent is performing its operations with credentials of the VO administrator as defined
-in the ``/Registry/VO/<VO_name>`` configuration section. See also :ref:`registry_vo`.
+in the ``/Registry/VO/<VO_name>`` configuration section.
 
 The following options can be set for the VOMS2CSAgent.
 

@@ -7,6 +7,20 @@
   Add a new DIRAC SiteName to DIRAC Configuration, including one or more CEs.
   If site is already in the CS with another name, error message will be produced.
   If site is already in the CS with the right name, only new CEs will be added.
+
+Usage:
+
+  dirac-admin-add-site [option|cfgfile] ... DIRACSiteName GridSiteName CE [CE] ...
+
+Arguments:
+
+  DIRACSiteName:  Name of the site for DIRAC in the form GRID.LOCATION.COUNTRY (ie:LCG.CERN.ch)
+  GridSiteName:   Name of the site in the Grid (ie: CERN-PROD)
+  CE:             Name of the CE to be included in the site (ie: ce111.cern.ch)
+
+Example:
+
+  $ dirac-admin-add-site LCG.IN2P3.fr IN2P3-Site
 """
 __RCSID__ = "$Id$"
 
@@ -18,17 +32,7 @@
 
 if __name__ == "__main__":
 
-  Script.setUsageMessage(
-      '\n'.join(
-          [
-              __doc__.split('\n')[1],
-              'Usage:',
-              '  %s [option|cfgfile] ... DIRACSiteName GridSiteName CE [CE] ...' %
-              Script.scriptName,
-              'Arguments:',
-              '  DIRACSiteName: Name of the site for DIRAC in the form GRID.LOCATION.COUNTRY (ie:LCG.CERN.ch)',
-              '  GridSiteName: Name of the site in the Grid (ie: CERN-PROD)',
-              '  CE: Name of the CE to be included in the site (ie: ce111.cern.ch)']))
+  Script.setUsageMessage(__doc__)
   Script.parseCommandLine(ignoreErrors=True)
   args = Script.getPositionalArgs()
 

@@ -5,18 +5,21 @@
 # Author :  Matvey Sapunov
 ########################################################################
 """
-  Sort site names at CS in "/Resources" section. Sort can be alphabetic or by country postfix in a site name.
-  Alphabetic sort is default (i.e. LCG.IHEP.cn, LCG.IHEP.su, LCG.IN2P3.fr)
+Sort site names at CS in "/Resources" section. Sort can be alphabetic or by country postfix in a site name.
+Alphabetic sort is default (i.e. LCG.IHEP.cn, LCG.IHEP.su, LCG.IN2P3.fr)
 
-  Options:
-    -C --country              Sort site names by country postfix (i.e. LCG.IHEP.cn, LCG.IN2P3.fr, LCG.IHEP.su)
-    -R --reverse              Reverse the sort order
+Usage:
 
-  Argument:
-    Name of the subsection in the CS '/Resources/Sites/' section to be sorted (i.e. LCG, DIRAC)
+  dirac-admin-sort-cs-sites [option|cfgfile] <Section>
 
-  Example: dirac-admin-sort-cs-sites -C DIRAC
-  Sort sites in subsection /Resources/Sites/DIRAC by country postfix
+Optional arguments:
+
+  Section:       Name of the subsection in '/Resources/Sites/' for sort (i.e. LCG DIRAC)
+
+Example:
+
+  $ dirac-admin-sort-cs-sites -C CLOUDS DIRAC
+  sort site names by country postfix in '/Resources/Sites/CLOUDS' and '/Resources/Sites/DIRAC' subsection
 """
 __RCSID__ = "$Id$"
 
@@ -50,27 +53,13 @@ def country(arg):
   return cb[2]
 
 
+Script.setUsageMessage(__doc__)
 Script.registerSwitch(
     "C",
     "country",
     "Sort site names by country postfix (i.e. LCG.IHEP.cn, LCG.IN2P3.fr, LCG.IHEP.su)",
     sortBy)
 Script.registerSwitch("R", "reverse", "Reverse the sort order", isReverse)
-
-Script.setUsageMessage(
-    "\n".join(
-        [
-            __doc__.split("\n")[1],
-            "Usage:",
-            "  %s [option|cfgfile] <Section>" %
-            Script.scriptName,
-            "Optional arguments:",
-            "  Section:       Name of the subsection in '/Resources/Sites/' for sort (i.e. LCG DIRAC)",
-            "Example:",
-            "  dirac-admin-sort-cs-sites -C CLOUDS DIRAC",
-            "  sort site names by country postfix in '/Resources/Sites/CLOUDS' and '/Resources/Sites/DIRAC' subsection",
-            ""]))
-
 Script.parseCommandLine(ignoreErrors=True)
 args = Script.getPositionalArgs()
 

@@ -4,7 +4,15 @@
 # Author : Adria Casajus
 ########################################################################
 """
-  Dump DIRAC Configuration data
+Dump DIRAC Configuration data
+
+Usage:
+
+  dirac-configuration-dump-local-cache [option|cfgfile] ...
+
+Example:
+
+  $ dirac-configuration-dump-local-cache -f /tmp/dump-conf.txt
 """
 from __future__ import print_function
 
@@ -34,11 +42,9 @@ def setRaw(args):
   return DIRAC.S_OK()
 
 
+Script.setUsageMessage(__doc__)
 Script.registerSwitch("f:", "file=", "Dump Configuration data into <file>", setFilename)
 Script.registerSwitch("r", "raw", "Do not make any modification to the data", setRaw)
-Script.setUsageMessage('\n'.join([__doc__.split('\n')[1],
-                                  'Usage:',
-                                  '  %s [option|cfgfile] ...' % Script.scriptName, ]))
 Script.parseCommandLine()
 
 from DIRAC import gConfig, gLogger

@@ -3,18 +3,26 @@
 # File :   dirac-agent
 # Author : Adria Casajus, Andrei Tsaregorodtsev, Stuart Paterson
 ########################################################################
-__RCSID__ = "$Id$"
+"""
+This is a script to launch DIRAC agents. Mostly internal.
+
+Usage::
+
+  dirac-agent (<options>|<cfgFile>)*
 
-"""  This is a script to launch DIRAC agents
 """
 
+__RCSID__ = "$Id$"
+
 import sys
-from DIRAC.ConfigurationSystem.Client.LocalConfiguration import LocalConfiguration
+
 from DIRAC import gLogger
 from DIRAC.Core.Base.AgentReactor import AgentReactor
 from DIRAC.Core.Utilities.DErrno import includeExtensionErrors
+from DIRAC.ConfigurationSystem.Client.LocalConfiguration import LocalConfiguration
 
 localCfg = LocalConfiguration()
+localCfg.setUsageMessage(__doc__)
 
 positionalArgs = localCfg.getPositionalArguments()
 if len(positionalArgs) == 0:

@@ -1,22 +1,52 @@
 #!/usr/bin/env python
 """
-Deploy all scripts and extensions
-Options:
- * --symlink: this will create symlinks instead of wrappers
- * <python path>: you can specify the folder where your python installation should be fetched from
+Deploy all scripts and extensions.
+This script is not meant to be called by users (it's automatically called by dirac-install).
+
+Usage::
+
+  dirac-deploy-scripts (<options>|<cfgFile>)* ... <python path>
+
+Arguments::
+  python path:    you can specify the folder where your python installation should be fetched from
                   to replace the shebang
+
+Example::
+
+  $ dirac-deploy-scripts
 """
 from __future__ import print_function
+
 __RCSID__ = "$Id$"
 
-import getopt
 import os
-import shutil
-import stat
 import re
 import sys
+import stat
+import getopt
+import shutil
 import platform
 
+cmdOpts = (('', 'symlink', 'this will create symlinks instead of wrappers'),
+           ('', 'module=', 'module in which to look for the scripts'),
+           ('h', 'help', 'help doc string'))
+
+
+def usage(err=''):
+  """ Usage printout
+
+      :param str err: will print something like "option -a not recognized"
+  """
+  if err:
+    print(err)
+  print(__doc__)
+  print('Options::\n\n')
+  for cmdOpt in cmdOpts:
+    print("  %s %s : %s" % (cmdOpt[0].ljust(3), cmdOpt[1].ljust(20), cmdOpt[2]))
+
+  sys.exit(2 if err else 0)
+
+
 DEBUG = False
 
 moduleSuffix = "DIRAC"
@@ -45,12 +75,15 @@
 module = None
 
 try:
-  opts, args = getopt.getopt(sys.argv[1:], "", ["symlink", "module="])
+  opts, args = getopt.getopt(sys.argv[1:],
+                             "".join([opt[0] for opt in cmdOpts]),
+                             [opt[1] for opt in cmdOpts])
 except getopt.GetoptError as err:
-  # print help information and exit:
-  print(str(err))  # will print something like "option -a not recognized"
-  sys.exit(2)
+  # print help information and exit
+  usage(str(err))
 for o, a in opts:
+  if o in ('-h', '--help'):
+    usage()
   if o == "--symlink":
     useSymlinks = True
   elif o == "--module":

@@ -3,18 +3,25 @@
 # File :   dirac-executor
 # Author : Adria Casajus
 ########################################################################
-__RCSID__ = "$Id$"
+"""
+This is a script to launch DIRAC executors
+
+Usage::
+
+  dirac-executor (<options>|<cfgFile>)*
 
-"""  This is a script to launch DIRAC executors
 """
 
+__RCSID__ = "$Id$"
+
 import sys
 from DIRAC.ConfigurationSystem.Client.LocalConfiguration import LocalConfiguration
 from DIRAC import gLogger
 from DIRAC.Core.Base.ExecutorReactor import ExecutorReactor
 from DIRAC.Core.Utilities.DErrno import includeExtensionErrors
 
 localCfg = LocalConfiguration()
+localCfg.setUsageMessage(__doc__)
 
 positionalArgs = localCfg.getPositionalArguments()
 if len(positionalArgs) == 0:

@@ -4,7 +4,19 @@
 # Author :  Andrei Tsaregorodtsev
 ########################################################################
 """
-  Report info about local DIRAC installation
+Report info about local DIRAC installation
+
+Usage:
+
+  dirac-info [option|cfgfile] ... Site
+
+Example:
+
+  $ dirac-info
+         DIRAC version : v5r12
+                 Setup : Dirac-Production
+   ConfigurationServer : ['dips://dirac.in2p3.fr:9135/Configuration/Server']
+   VirtualOrganization : vo.formation.idgrilles.fr
 """
 
 from __future__ import print_function
@@ -19,11 +31,23 @@
 from DIRAC.ConfigurationSystem.Client.Helpers.Registry import getVOForGroup
 from DIRAC.Core.Utilities.PrettyPrint import printTable
 
-Script.setUsageMessage('\n'.join([__doc__.split('\n')[1],
-                                  'Usage:',
-                                  '  %s [option|cfgfile] ... Site' % Script.scriptName, ]))
+
+def version(arg):
+  Script.disableCS()
+  print(DIRAC.version)
+  DIRAC.exit(0)
+
+
+def platform(arg):
+  Script.disableCS()
+  print(DIRAC.getPlatform())
+  DIRAC.exit(0)
+
+
+Script.setUsageMessage(__doc__)
+Script.registerSwitch("v", "version", "print version of current DIRAC installation", version)
+Script.registerSwitch("p", "platform", "print platform of current DIRAC installation", platform)
 Script.parseCommandLine(ignoreErrors=True)
-args = Script.getPositionalArgs()
 
 records = []
 

@@ -1,37 +1,36 @@
 #!/usr/bin/env python
-""" dirac-install-extension command allows to add a specified extension
-to an already existing DIRAC installation. No new version directory is created.
-The command is based on the main DIRAC installer dirac-install.py.
+"""
+Allows to add a specified extension to an already existing DIRAC installation.
+The extension can come from another project than the one installed.
+No new version directory is created. The command is based on the main DIRAC installer dirac-install.py.
+
+Usage::
 
-The valid options are:
+  dirac-install-extension (<options>|<cfgFile>)*
 
-  -l <project> - the project in which the extension is developed
-  -r <release> - the project release version
-  -e <extension> - the extension name. Several -e options can be given
 """
 
 from __future__ import unicode_literals, absolute_import, division, print_function
 
 import os
 import sys
-import importlib
-import getopt
-import time
 import six
+import time
+import getopt
+import importlib
 
 cmdOpts = (('r:', 'release=', 'Release version to install'),
            ('l:', 'project=', 'Project to install'),
-           ('e:', 'extensions=', 'Extensions to install (comma separated)'),
+           ('e:', 'extensions=', 'Extensions to install (comma separated). Several -e options can be given'),
+           ('M:', 'defaultsURL=', 'Where to retrieve the global defaults from'),
            ('h', 'help', 'help doc string'))
 
 
 def usage():
   """ Usage printout
   """
-  print("\nThe command allows to add a specified extension to an already existing DIRAC installation.\n"
-        "The extension can come from another project than the one installed.")
-  print("\nUsage:\n\n  %s <opts> <cfgFile>" % os.path.basename(sys.argv[0]))
-  print("\nOptions:")
+  print(__doc__)
+  print('Options::\n\n')
   for cmdOpt in cmdOpts:
     print("  %s %s : %s" % (cmdOpt[0].ljust(3), cmdOpt[1].ljust(20), cmdOpt[2]))