Unix manual pages for gmex, gmcat, gmstatistics,fullsimlight,fsl,gmmasscalc, and gmclash

FSL/CMakeLists.txt

@@ -2,6 +2,8 @@ cmake_minimum_required(VERSION 3.16...3.26)
 
 project(fsl VERSION 0.1 LANGUAGES CXX)
 
+file( GLOB MANPAGES man/man1/* )
+
 if(CMAKE_SOURCE_DIR STREQUAL PROJECT_SOURCE_DIR)
     # I am top-level project.
     # Make the root module directory visible to CMake.
@@ -96,3 +98,7 @@ install( TARGETS fsl
    LIBRARY DESTINATION ${CMAKE_INSTALL_BINDIR}
    COMPONENT Runtime )
 
+
+install( FILES ${MANPAGES}
+   DESTINATION ${CMAKE_INSTALL_PREFIX}/man/man1
+   COMPONENT Runtime )

FSL/man/man1/fsl.1

+.\" Manpage for fsl.
+.\" Contact geomodel-core-team@cern.ch to correct errors or typos.
+.TH man 1 "01 Nov 2024" "6.5" "fsl man page"
+.SH NAME
+fsl \- user interface for fullSimLight Geant4 simulation.
+.SH SYNOPSIS
+
+fsl [-c JsonConfigFile]
+
+.SH DESCRIPTION
+fsl is a graphical user front-end to fullSimLight. fsl/fullSimLight 
+runs Geant4 simulation using input files containing 1) event data,
+2) geometry data, and 3) configuration data.
+
+Using the fsl application, one can configure and launch the simulation
+interactively through a series of menus. The menus allow to select
+the event type and input source, the geometry input, the magnetic
+field, and any plugins.  A number of example plugins appear in the
+menus.  For more information on writing custom plugins, see the web
+page
+.IR geomodel.web.cern.ch \.
+
+Default configuration files for fsl are typically installed in
+/usr/share/fsl on linux systems. 
+
+Users can either run fullSimLight simulation from within fsl or simply
+configure the simulation, in which case the configuration may be saved
+to a json file.  The json file may read back into fsl
+for further editing (see the -c option below) or passed to fullSimLight
+on the command line.
+
+From the fsl main window, users may run the gmex geometry explorer,
+and/or the gmclash clash detection utility, in addition to fullSimLight.  
+
+.SH OPTIONS
+
+.TP
+.BI \-c \ JsonConfigFile
+Open a fullSimLight configuration file for further interactive configuration.
+
+.\" ====================================================================
+.SH "SEE ALSO"
+.\" ====================================================================
+.
+gmcat(1), gmclash(1), gmstatistics(1), gmex(1), fullSimLight(1) 
+
+
+.IR "geant4.web.cern.ch"
+is the web page for the Geant4 toolkit, the development of which is led
+by CERN.
+
+.IR "pythia.org"
+is the web page for the pythia event generator
+
+.IR "geomodel.web.cern.ch"
+is the location of the main documentation for the GeoModel Tools Suite. 
+.
+
+.SH AUTHORS
+.MT Marilena.Bandieramonte@\:cern\:.ch
+Marilena Bandieramonte
+.ME ,
+.MT Raees.Ahmad.Khan@\:cern\:.ch
+Raees Khan
+.ME
+and
+.MT boudreau@\:pitt\:.edu
+Joe Boudreau
+.ME .

FullSimLight/CMakeLists.txt

@@ -3,6 +3,9 @@
 # CMake settings
 cmake_minimum_required(VERSION 3.16...3.26)
 
+
+file( GLOB MANPAGES man/man1/* )
+
 #Set up the project. Check if we build it with GeoModel or individually
 if(CMAKE_SOURCE_DIR STREQUAL CMAKE_CURRENT_SOURCE_DIR)
   # I am top-level project.
@@ -222,3 +225,8 @@ install(FILES FullSimLight/FSLSensitiveDetectorPlugin.h
     	      FullSimLight/FSLUserActionPlugin.h
   DESTINATION ${CMAKE_INSTALL_INCLUDEDIR}/FullSimLight
   COMPONENT Development )
+
+
+install( FILES ${MANPAGES}
+   DESTINATION ${CMAKE_INSTALL_PREFIX}/man/man1
+   COMPONENT Runtime )

FullSimLight/man/man1/fullSimLight.1

+.\" Manpage for fullSimLight.
+.\" Contact geomodel-core-team@cern.ch to correct errors or typos.
+.TH man 1 "01 Nov 2024" "6.5" "fullSimLight man page"
+.SH NAME
+fullSimLight \- Geant4 simulation from the command line
+.SH SYNOPSIS
+
+fullSimLight [-g geometry-input]  [-m macro-file] [-f physics-list-name] [-P pythia-event-type] [-p] [-o] [h]  ...
+
+fullSimLight [-c json-config-file]
+
+.SH DESCRIPTION
+fullSimLight is a command-line interface to the Geant4, the toolkit
+for simulation of particle transport and interaction with matter used
+in particle physics and medical physics.  fullSimLight takes geometry
+data from a source specified on the command line. Event data is also
+taken from a source specified on the command line or generated
+internally using the Pythia event generator. Plugins for User Actions
+and Sensitive Detectors can be used to interrupt processing, for
+example in order to generate and record hits; by default no output is
+generated.  fullSimLight is intended as a convenient way to develop,
+study, and benchmark Geant4 simulation outside of the context of large
+scale applications.
+
+Default configuration files for fullSimLight are typically installed in
+/usr/share/FullSimLight on linux systems. 
+
+The fullSimLight application can be run from the command line, or alternately,
+through the graphical user interface fsl (see fsl(1)). By default it runs 10
+events, each consisting of a single electron of energy 10 Gev and produces no
+output. 
+
+For more information on writing custom plugins for fullSimLight, see the web
+page
+.IR geomodel.web.cern.ch \.
+
+.SH OPTIONS
+
+.TP
+.BI \-c \ json-config-file
+Configure the run of fullSimLight through options recorded in a json
+configuration file.  These files are most easily produced through the
+fsl utility (see fsl(1)), a graphical user front-end to fullSimLight. 
+
+.TP
+.BI \-g \ geometry-input
+Specifies the geometry input.  The input may be a GeoModel plugin, an SQLite
+file containing a GeoModel description of a geometry, or a GDML file containing
+a GDML description of a geometry. 
+
+
+.TP
+.BI \-m \ macro-file
+Override the Macro file used to steer Geant4 (typically installed in /usr/share/FullSimLight) with a custom macro file. 
+
+.TP
+.BI \-f \ physics-list-name 
+Geant4 physics list name. Currently FTP_BERT is default. 
+
+.TP
+.BI \-P \ event-type
+Use the pythia primary event generator to generate events of specified type,
+which may be ttbar (top antitop production), higgs (higgs boson production), 
+or minbias (minimum bias events), each arising from proton-proton collisions
+at 13 TeV center-of-mass energy.
+
+.TP
+.BI \-o
+Check for geometry overlaps
+
+.TP
+.BI \-p
+Run in performance mode
+
+.TP
+.BI \-h
+Prints a help message
+
+
+
+
+
+.\" ====================================================================
+.SH "SEE ALSO"
+.\" ====================================================================
+.
+gmcat(1), gmclash(1), gmstatistics(1), gmex(1), fsl(1) 
+
+
+.IR "geant4.web.cern.ch"
+is the web page for the Geant4 toolkit, the development of which is led
+by CERN.
+
+.IR "pythia.org"
+is the web page for the pythia event generator
+
+.IR "geomodel.web.cern.ch"
+is the location of the main documentation for the GeoModel Tools Suite. 
+.
+
+.SH AUTHORS
+
+.MT Marilena.Bandieramonte@\:cern\:.ch
+Marilena Bandieramonte
+.ME ,
+.MT Raees.Ahmad.Khan@\:cern\:.ch
+Raees Khan
+.ME
+and 
+.MT boudreau@\:pitt\:.edu
+Joe Boudreau
+.ME .

FullSimLight/man/man1/gmclash.1

+.\" Manpage for gmclash.
+.\" Contact geomodel-core-team@cern.ch to correct errors or typos.
+.TH man 1 "01 Nov 2024" "6.5" "gmclash man page"
+.SH NAME
+gmclash \- detect and report clashes in a geometry model
+.SH SYNOPSIS
+
+gmclash [-g geometry-input]  [-r root-volume-name] [-o output-file-name] [-t tolerance] [-n number=random-points] [-v] [h]  ...
+
+.SH DESCRIPTION
+gmclash is a command-line utility for detecting and reporting overlaps (or
+clashes) in a geometry model. The geometry may be provided
+in the form of a GeoModel description in an SQLite file, a GDML file
+description, or a GeoModel plugin with .so or .dylib extension. gmclash
+reports several abnormal conditions:  Mother/Daughter clashes, Sister/Sister
+clashes, Encapsulated sister clashes, or invalid solid.  The report is
+summarized in a .json file; this file may be opened in the ClashPoint system
+of the gmex Geometry Explorer (see gmex(1)) and co-displayed with the
+geometry. 
+
+gmclash uses the Geant4 toolkit. 
+
+.SH OPTIONS
+
+.TP
+.BI \-o \ output-file-name
+Specify OutputFile.  Default: gmclash_report.json
+
+.TP
+.BI \-g \ geometry-input
+Specifies the geometry input.  The input may be a GeoModel plugin, an SQLite
+file containing a GeoModel description of a geometry, or a GDML file containing
+a GDML description of a geometry. 
+
+.TP
+.BI \-r \ root-volume-name
+Specify root volume name.  If not specified, all volumes are considered. 
+
+.TP
+.BI \-t \ tolerance
+Set the threshold value for clash reporting. 
+
+.TP
+.BI \-n
+Specify the number of random points per volume (default: 1000) 
+
+.TP
+.BI \-h
+Prints a help message
+
+.TP
+.BI \-v
+Enable verbose output 
+
+
+
+
+
+.\" ====================================================================
+.SH "SEE ALSO"
+.\" ====================================================================
+.
+gmcat(1), gmmasscalc(1), gmstatistics(1), gmex(1), fullSimLight(1), fsl(1) 
+
+
+.IR "geant4.web.cern.ch"
+is the web page for the Geant4 toolkit, the development of which is led
+by CERN.
+
+.IR "geomodel.web.cern.ch"
+is the location of the main documentation for the GeoModel Tools Suite. 
+.
+
+.SH AUTHORS
+
+.MT Marilena.Bandieramonte@\:cern\:.ch
+Marilena Bandieramonte
+.ME
+

FullSimLight/man/man1/gmmasscalc.1

+.\" Manpage for gmmasscalc.
+.\" Contact geomodel-core-team@cern.ch to correct errors or typos.
+.TH man 1 "01 Nov 2024" "6.5" "gmmasscalc man page"
+.SH NAME
+gmmasscalc \- detect and report clashes in a geometry model
+.SH SYNOPSIS
+
+gmmasscalc [-g geometry-input]  [-p prefix-logical-volume] [-o output-file-name] [-m material-of-interest] [-v] [h]  ...
+
+.SH DESCRIPTION
+gmmasscalc is a command-line utility for performing a mass inventory of
+a geometry model. The geometry may be provided in the form of a GeoModel description in an SQLite file, a GDML file description, or a GeoModel plugin with .so or .dylib extension. gmmasscalc reports the total inclusive mass, the total inclusive mass, and the apparent weight in air of the geometry. A summary in the form of a .json file is also saved.   
+
+gmmasscalc uses the Geant4 toolkit. 
+
+.SH OPTIONS
+
+.TP
+.BI \-o \ output-file-name
+Specify the output file.  Default: gmmasscalc_report.json
+
+.TP
+.BI \-g \ geometry-input
+Specify the geometry input.  The input may be a GeoModel plugin, an SQLite
+file containing a GeoModel description of a geometry, or a GDML file containing
+a GDML description of a geometry. 
+
+.TP
+.BI \-p \ prefix-logical-volume
+Specify root volume name.  If not specified, all volumes are considered. 
+
+.TP
+.BI \-m \ material-of-interest
+Restrict the inventory to volumes of specific material composition. 
+
+.TP
+.BI \-h
+Prints a help message
+
+.TP
+.BI \-v
+Enable verbose output 
+
+
+
+
+
+.\" ====================================================================
+.SH "SEE ALSO"
+.\" ====================================================================
+.
+gmcat(1), gmclash(1), gmstatistics(1), gmex(1), fullSimLight(1), fsl(1) 
+
+
+.IR "geant4.web.cern.ch"
+is the web page for the Geant4 toolkit, the development of which is led
+by CERN.
+
+.IR "geomodel.web.cern.ch"
+is the location of the main documentation for the GeoModel Tools Suite. 
+.
+
+.SH AUTHORS
+
+.MT Marilena.Bandieramonte@\:cern\:.ch
+Marilena Bandieramonte
+.ME
+

GeoModelTools/GMCAT/CMakeLists.txt

 # Copyright (C) 2002-2020 CERN for the benefit of the ATLAS collaboration
 
+
+file( GLOB MANPAGES man/man1/* )
+
 # Declare the package's executable.
 add_executable( gmcat src/gmcat.cxx src/publishMetaData.cpp)
 target_link_libraries( gmcat PRIVATE GeoModelCore::GeoModelKernel
@@ -21,3 +24,7 @@ install( TARGETS gmcat
    EXPORT ${PROJECT_NAME}-export
    RUNTIME DESTINATION ${CMAKE_INSTALL_BINDIR}
    COMPONENT Runtime )
+
+install( FILES ${MANPAGES}
+   DESTINATION ${CMAKE_INSTALL_PREFIX}/man/man1
+   COMPONENT Runtime )

GeoModelTools/GMCAT/man/man1/gmcat.1

+.\" Manpage for gmcat
+.\" Contact geomodel-core-team@cern.ch to correct errors or typos.
+.TH man 1 "01 Nov 2024" "6.5" "gmex man page"
+.SH NAME
+gmcat \- Write geomodel data to an SQLite file 
+.SH SYNOPSIS
+gmcat [inputFile1] [InputFile2] ... [Plugin1] [Plugin2] ... -o outputFile  [-v] [-g Repository]
+.SH DESCRIPTION
+gmcat takes one or more input files containing a GeoModel description in SQLite format, one or more  plugins which construct the GeoModel description, or a  mix of files and plugins, and outputs the GeoModel description to an SQLite file, along with metadata.
+.SH OPTIONS
+
+.TP
+.BI \-g \ Repository
+Record information about an external git-managed repository in the metadata.  Default is current working directory. 
+.TP
+.BI \-v 
+Print verbose output to the screen (default: direct verbose output to /tmp)
+
+
+
+.\" ====================================================================
+.SH "SEE ALSO"
+.\" ====================================================================
+.
+gmex(1), sqlitebrowser(1), gmstatistics(1)
+
+.IR "geomodel.web.cern.ch" 
+is the location of the main documentation for the GeoModel Tools Suite
+.
+
+.SH BUGS
+There are no known bugs.
+.SH AUTHORS
+Primary authors are 
+.MT riccardomariabianchi@\:pitt\:.edu
+Riccardo Maria Bianchi
+.ME ,
+.MT boudreau@\:pitt\:.edu
+Joe Boudreau
+.ME
+and
+.MT Vakhtang.Tsulaia@\:cern\:.ch
+Vakho Tsulaia
+.ME

GeoModelTools/GMSTATISTICS/CMakeLists.txt

 # Copyright (C) 2002-2020 CERN for the benefit of the ATLAS collaboration
 
+
+
+file( GLOB MANPAGES man/man1/* )
+
 # Declare the package's executable.
 add_executable( gmstatistics src/gmstatistics.cxx  src/GeoInventoryGraphAction.cxx )
 target_link_libraries( gmstatistics PRIVATE GeoModelCore::GeoModelKernel
@@ -20,3 +24,8 @@ install( TARGETS gmstatistics
    EXPORT ${PROJECT_NAME}-export
    RUNTIME DESTINATION ${CMAKE_INSTALL_BINDIR}
    COMPONENT Runtime )
+
+
+install( FILES ${MANPAGES}
+   DESTINATION ${CMAKE_INSTALL_PREFIX}/man/man1
+   COMPONENT Runtime )

GeoModelTools/GMSTATISTICS/man/man1/gmstatistics.1

+.\" Manpage for gmstatistics
+.\" Contact geomodel-core-team@cern.ch to correct errors or typos.
+.TH man 1 "01 Nov 2024" "6.5" "gmex man page"
+.SH NAME
+gmstatistics \- Print memory consumption and other information about GeoModel plugins 
+.SH SYNOPSIS
+gmstatistics [Plugin1] [Plugin2] ... -o outputFile  [-v] [-g Repository]
+.SH DESCRIPTION
+gmstatistics takes one or more  plugins which construct the GeoModel description and prints an informative message about resource usage.  The information available depends on the platform, since different platforms provide different system calls for resource monitoring. On linux, the program reports the total memory as well as the memory consumed exclusively by the geometry data (ie. the geomodel tree).  On the macintosh, a detailed report containing the number of allocated objects by class and the total memory footprint of the allocated objects is also printed.  With the -p option, a dump of the geometry tree is also printed.
+
+gmstatistics only works with plugins, it does not accept input files in SQLite format. 
+
+.SH OPTIONS
+
+.TP
+.BI \-p 
+Prints the geometry tree.
+
+
+
+.\" ====================================================================
+.SH "SEE ALSO"
+.\" ====================================================================
+.
+gmex(1), sqlitebrowser(1), gmcat (1)
+
+.IR "geomodel.web.cern.ch" 
+is the location of the main documentation for the GeoModel Tools Suite
+.
+
+.SH BUGS
+There are no known bugs.
+.SH AUTHORS
+Primary authors are 
+.MT riccardomariabianchi@\:pitt\:.edu
+Riccardo Maria Bianchi
+.ME ,
+.MT boudreau@\:pitt\:.edu
+Joe Boudreau
+.ME
+and
+.MT Vakhtang.Tsulaia@\:cern\:.ch
+Vakho Tsulaia
+.ME
+

GeoModelVisualization/GeoModelExplorer/CMakeLists.txt

 # Copyright (C) 2002-2020 CERN for the benefit of the ATLAS collaboration
 
+file( GLOB MANPAGES man/man1/* )
+
 # Add the executable.
 add_executable( gmex src/main.cxx )
 
@@ -15,3 +17,7 @@ install( TARGETS gmex
    EXPORT ${PROJECT_NAME}-export
    LIBRARY DESTINATION ${CMAKE_INSTALL_BINDIR}
    COMPONENT Runtime )
+   
+install( FILES ${MANPAGES}
+   DESTINATION ${CMAKE_INSTALL_PREFIX}/man/man1
+   COMPONENT Runtime )

GeoModelVisualization/GeoModelExplorer/man/man1/gmex.1

+.\" Manpage for gmex.
+.\" Contact geomodel-core-team@cern.ch to correct errors or typos.
+.TH man 1 "01 Nov 2024" "6.5" "gmex man page"
+.SH NAME
+gmex \- The Geometry Explorer 
+.SH SYNOPSIS
+gmex [input-file-1] [input-file-2] ... [plugin-1] [plugin-2] ...
+.SH DESCRIPTION
+gmex, the geometry explorer, is an interactive 3D graphics program which
+renders geometry from plugins (shared object libraries which produce and
+publish geometry in GeoModel format) or GeoModel geometries stored in
+SQLite files (see gmcat(1)). Multiple files, multiple plugins, or a mix
+can be provided to gmcat on the command line. 
+
+Gmex is controlled by buttons on the right hand side of the display.
+The most important of these are those displaying a hand, an arrow, and
+an eye. The "eye" button brings the scene into scope.  The arrow and hand
+buttons toggle between interaction mode in which the mouse modifies
+the camera position and angle, and selection mode in which the mouse
+buttons select geometry. Geometry selection can trigger various actions,
+depending on selected options.
+
+Gmex can co-display the results of gmclash, the clash detection system
+(see gmclash(1)). To enable, launch the "clash point" system from the
+main menu. 
+
+
+
+.\" ====================================================================
+.SH "SEE ALSO"
+.\" ====================================================================
+.
+gmcat(1), gmclash(1), gmstatistics(1)
+
+.IR "geomodel.web.cern.ch" 
+is the location of the main documentation for the GeoModel Tools Suite
+.
+.SH BUGS
+There are no known bugs, however gmex does rely on graphics acceleration
+so the performance depends upon the windowing system, the GPU, the graphics
+drivers, and their configuration.  Performance under the Wayland flavor
+of window manager on linux systems is poor, and the X-windows manager is
+preferred. Users with NVidia GPUs should use the nvidia-settings utility
+(see nvidia-settings(1)). 
+.SH AUTHORS
+Primary authors are 
+.MT boudreau@\:pitt\:.edu
+Joe Boudreau
+.ME ,
+.MT Vakhtang.Tsulaia@\:cern\:.ch
+Vakho Tsulaia
+.ME , 
+.MT riccardomariabianchi@\:pitt\:.edu
+Riccardo Maria Bianchi, 
+.ME
+Thomas Kittelman, and
+.MT edward.moyse@\:cern\:.ch
+Edward Moyse
+.ME .