Skip to content
Snippets Groups Projects
Commit 62f3ed5f authored by Joseph Boudreau's avatar Joseph Boudreau
Browse files

New man page added for gmgeantino

parent cb4e9f72
No related branches found
Tags 6.7.0
1 merge request!388New man page added for gmgeantino
Pipeline #9282473 skipped
......@@ -5,7 +5,7 @@
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 [-g geometry-input] [-m macro-file] [-f physics-list-name] [-P pythia-event-type] [-p] [-o] [-h] ...
fullSimLight [-c json-config-file]
......@@ -84,7 +84,7 @@ Prints a help message
.SH "SEE ALSO"
.\" ====================================================================
.
gmcat(1), gmclash(1), gmstatistics(1), gmex(1), fsl(1)
gmcat(1), gmclash(1), gmstatistics(1), gmex(1), fsl(1), gmmasscalc(1), gmgeantino(1)
.IR "geant4.web.cern.ch"
......
......@@ -5,7 +5,7 @@
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] ...
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
......@@ -60,7 +60,7 @@ Enable verbose output
.SH "SEE ALSO"
.\" ====================================================================
.
gmcat(1), gmmasscalc(1), gmstatistics(1), gmex(1), fullSimLight(1), fsl(1)
gmcat(1), gmmasscalc(1), gmstatistics(1), gmex(1), fullSimLight(1), fsl(1), gmgeantino(1)
.IR "geant4.web.cern.ch"
......
.\" Manpage for gmgeantino.
.\" Contact geomodel-core-team@cern.ch to correct errors or typos.
.TH man 1 "01 Nov 2024" "6.5" "gmgeantino man page"
.SH NAME
gmgeantino \- perform geantino scans on an input geometry
.SH SYNOPSIS
gmgeantino [-g geometry-input] [-m macro-file] [-o output-root-file] [-e] [-h]
.\" [-a] [-l] [-h] not working yet, disabled in this version
.SH DESCRIPTION
gmgeantino is a command-line utility to perform geantino scans on an
input geometry.
A "geantino" is an imaginary particle that traverses a detector,
carrying out an inventory of material properties as it does so. The program
produces one and two dimensional output plots in root format which can
be examined using the root program (see root.cern.ch)
.SH OPTIONS
.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 \-o \ output-file
Set the name of the output files, in root format (see root.cern.ch). The default
output file name is geantinoMaps.root.
.TP
.BI \-e
Use this flag to create eta-phi radiation-interaction length 1D profile histograms
.\" .TP
.\" .BI \-d
.\" Use this flag to create xy-rz radiation-interaction length 2D profile histograms for 'detectors'
.\" .TP
.\" .BI \-a
.\" Use this flag to create xy-rz radiation-interaction length 2D profile histograms for 'materials'
.\" .TP
.\" .BI \-l
.\" Use this flag to create xy-rz radiation-interaction length 2D profile histograms for 'elements'
.TP
.BI \-h
Prints a help message
.\" ====================================================================
.SH "SEE ALSO"
.\" ====================================================================
.
gmcat(1), gmclash(1), gmstatistics(1), gmmasscalc(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 "root.cern.ch"
is the web page for the root project
.IR "geomodel.web.cern.ch"
is the location of the main documentation for the GeoModel Tools Suite.
.
.\" .SH BUGS
.\" The -a, -l, and -d flags are not currently working and are under repair.
.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 .
......@@ -5,7 +5,7 @@
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] ...
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
......@@ -49,7 +49,7 @@ Enable verbose output
.SH "SEE ALSO"
.\" ====================================================================
.
gmcat(1), gmclash(1), gmstatistics(1), gmex(1), fullSimLight(1), fsl(1)
gmcat(1), gmclash(1), gmstatistics(1), gmex(1), fullSimLight(1), fsl(1), gmmasscalc(1), gmgeantino(1)
.IR "geant4.web.cern.ch"
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment