Skip to content

Commit

Permalink
Updated man pages
Browse files Browse the repository at this point in the history
  • Loading branch information
@kjvbrt
kjvbrt committed Jan 17, 2024
1 parent caffd04 commit cbe6ff3
Show file tree
Hide file tree
Showing 8 changed files with 411 additions and 324 deletions.
4 changes: 2 additions & 2 deletions .github/scripts/man2html.sh
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3,9 +3,9 @@
mkdir -p ./man/html
cd ./man/man1
for MANFILE in *; do
mandoc -Thtml -Ostyle=/css/mandoc.css "${MANFILE}" > "../html/${MANFILE::-1}html"
mandoc -Thtml -Ostyle=../../css/mandoc.css "${MANFILE}" > "../html/${MANFILE::-1}html"
done
cd ../man7
for MANFILE in *; do
mandoc -Thtml -Ostyle=/css/mandoc.css "${MANFILE}" > "../html/${MANFILE::-1}html"
mandoc -Thtml -Ostyle=../../css/mandoc.css "${MANFILE}" > "../html/${MANFILE::-1}html"
done
60 changes: 60 additions & 0 deletions man/man1/fccanalysis-build.1
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,60 @@
.\" Manpage for fccanalysis-build
.\" Contact [email protected] to correct errors or typos.
.TH FCCANALYSIS\-BUILD 1 "17 Jan 2024" "0.8.0" "fccanalysis-build man page"
.SH NAME
\fBfccanalysis\-build\fR \(en helper to build FCCAnalyses framework locally
.SH SYNOPSIS
.B fccanalysis build
[\fB\-h\fR | \fB\-\-help\fR]
[\fB\-c\fR]
[\fB\-j\fR \fIBUILD_THREADS\fR]
.SH DESCRIPTION
.B fccanalysis\-build
will build the whole FCCAnalyses framework\&.

This sub-command is not intended as a replacement for the CMake build procedure,
it just makes this task a little easier\&. The helper will build the framework in
the directory: build and install it into the directory: install\&.
.SH OPTIONS
.TP
.BR \-h ", " \-\-help
Prints short help message and exits\&.
.TP
.BR \-c ", " \-\-clean\-build
Completely clean build directory before compilation\&.
.TP
\fB\-j\fR \fIBUILD_THREADS\fR, \fB\-\-build\-threads\fR \fIBUILD_THREADS\fR
Specify number of threads used when compiling (equivalent to `make -j`)
.SH SEE ALSO
fccanalysis(1), fccanalysis\-test(7), cmake(1)
.SH BUGS
Many
.SH AUTHORS
There are many contributors to the FCCAnalyses framework, but the principal
authors are:
.in +4
Clement Helsens
.br
Valentin Volk
.br
Gerardo Ganis
.SH FCCANALYSES
Part of the FCCAnalyses framework\&.
.SH LINKS
.PP
.UR https://hep-fcc\&.github\&.io/FCCAnalyses/
FCCAnalyses webpage
.UE
.PP
.UR https://github\&.com/HEP\-FCC/FCCAnalyses/
FCCAnalysises GitHub repository
.UE
.PP
.UR https://fccsw\-forum\&.web\&.cern\&.ch/
FCCSW Forum
.UE
.SH CONTACT
.pp
.MT [email protected]
FCC-PED-SoftwareAndComputing-Analysis
.ME
150 changes: 57 additions & 93 deletions man/man1/fccanalysis-run.1
View file
Original file line number Diff line number Diff line change
@@ -1,125 +1,89 @@
.\" Manpage for fccanalysis
.\" Contact fcc-experiments-sw-dev@cern.ch to correct errors or typos.
.TH FCCANALYSIS\-RUN 1 "24 May 2023" "0.8.0" "fccanalysis-run man page"
.\" Manpage for fccanalysis-run
.\" Contact FCC-PED-SoftwareAndComputing-Analysis@cern.ch to correct errors or typos.
.TH FCCANALYSIS\-RUN 1 "17 Jan 2024" "0.8.0" "fccanalysis-run man page"
.SH NAME
fccanalysis\-run \- run FCC analysis
\fBfccanalysis\-run\fR \- run FCC analysis
.SH SYNOPSIS
.sp
.nf
\fIfccanalysis run\fR [\-h | \-\-help] [\-\-files\-list FILES_LIST [FILES_LIST ...]]
[\-\-output OUTPUT] [\-\-nevents NEVENTS] [\-\-test] [\-\-bench]
[\-\-ncpus NCPUS] [\-\-preprocess] [\-\-validate] [\-\-rerunfailed]
[\-\-jobdir JOBDIR] <analysis-file>
.fi
.sp
.B fccanalysis run
[\fB\-h\fR | \fB\-\-help\fR]
[\fB\-\-files\-list\fR \fIFILES_LIST\fR [\fIFILES_LIST\fR ...]]
[\fB\-\-output\fR \fIOUTPUT\fR]
[\fB\-\-nevents\fR \fINEVENTS\fR]
[\fB\-\-test\fR]
[\fB\-\-bench\fR]
[\fB\-\-ncpus\fR \fINCPUS\fR]
.I analysis-script
.SH DESCRIPTION
\fIfccanalysis-run\fR will run analysis provided in the analysis file\&. The
.B fccanalysis-run
will run analysis provided in the analysis file\&. The
analysis itself can be divided into several stages if desired\&. For all those
stages \fIfccanalysis-run\fR is used\&.
.sp
When using \fIfccanalysis-run\fR the analysis is running in the managed mode,
where the RDataFrame provided is steered by the framework and users can control
some aspects of the running with additional global attributes, see
\fBfccanalysis-file\fR(8).

When using \fBfccanalysis-run\fR the analysis is running in the managed mode,
where the RDataFrame is steered by the framework and users can control some
aspects of the running with additional global attributes, see
\fIfccanalysis-script\fR(8).
.SH OPTIONS
.PP
<analysis-file>
.RS 4
Path to analysis file\&.
.RE
.PP
\-\-help
.RS 4
.TP
.I analysis-script
Path to analysis script\&.
.TP
.BR \-h ", " \-\-help
Prints short help message and exits\&.
.RE
.PP
\-\-files\-list FILES_LIST [FILES_LIST ...]
.RS 4
.TP
\fB\-\-files\-list\fR \fIFILES_LIST\fR [\fIFILES_LIST\fR ...]
Specify input file to bypass the processList\&.
.RE
.PP
\-\-output OUTPUT
.RS 4
.TP
\fB\-\-output\fR \fIOUTPUT\fR
Specify output file name to bypass the processList and or outputList, default
\fIoutput.root\fR\&.
.RE
.PP
\-\-nevents NEVENTS
.RS 4
.TP
\fB\-\-nevents\fR \fINEVENTS\fR
Specify max number of events to process\&.
.RE
.PP
\-\-test
.RS 4
.TP
.B \-\-test
Run over the test file\&.
.RE
.PP
\-\-bench
.RS 4
.TP
.B \-\-bench
Output benchmark results to a JSON file\&.
.RE
.PP
\-\-ncpus NCPUS
.RS 4
.TP
\-\-ncpus \fINCPUS\fR
Set number of threads\&.
.RE
.PP
\-\-preprocess
.RS 4
Run preprocessing\&.
.RE
.PP
\-\-validate
.RS 4
Validate a given production\&.
.RE
.PP
\-\-rerunfailed
.RS 4
Rerun failed jobs\&.
.RE
.PP
\-\-jobdir JOBDIR
.RS 4
Specify the batch job directory\&.
.RE
.SH ENVIRONMENT VARIABLES
.PP
\fBFCCDICTSDIR\fR
.RS 4
.TP
.B FCCDICTSDIR
Controls search path for the process dictionaries. The default value is
\fI/cvmfs/fcc.cern.ch/FCCDicts/\fR\&.
.RE
.SH SEE ALSO
fccanalysis(1), fccanalysis-file(7)
fccanalysis(1), fccanalysis-script(7)
.SH BUGS
Many
.SH AUTHORS
There are many contributors to the FCCAnalyses framework, but the principal
authors are:
.br
.RS 4
.in +4
Clement Helsens
.br
Valentin Volk
.br
Gerardo Ganis
.RE
.SH FCCANALYSES
Part of the FCCAnalyses framework\&.
.SH LINKS
.PP
1\&. FCCAnalyses webpage
.RS 4
https://hep-fcc\&.github\&.io/FCCAnalyses/
.RE
.PP
2\&. FCCAnalysises GitHub repository
.RS
https://github\&.com/HEP\-FCC/FCCAnalyses/
.RE
.PP
3\&. FCCSW Forum
.RS
https://fccsw\-forum\&.web\&.cern\&.ch/
.RE
.UR https://hep-fcc\&.github\&.io/FCCAnalyses/
FCCAnalyses webpage
.UE
.PP
.UR https://github\&.com/HEP\-FCC/FCCAnalyses/
FCCAnalysises GitHub repository
.UE
.PP
.UR https://fccsw\-forum\&.web\&.cern\&.ch/
FCCSW Forum
.UE
.SH CONTACT
.pp
.MT [email protected]
FCC-PED-SoftwareAndComputing-Analysis
.ME
69 changes: 36 additions & 33 deletions man/man1/fccanalysis-test.1
View file
Original file line number Diff line number Diff line change
@@ -1,60 +1,63 @@
.\" Manpage for fccanalysis-test
.\" Contact fcc-experiments-sw-dev@cern.ch to correct errors or typos.
.TH FCCANALYSIS\-TEST 1 "17 June 2023" "0.8.0" "fccanalysis-test man page"
.\" Contact FCC-PED-SoftwareAndComputing-Analysis@cern.ch to correct errors or typos.
.TH FCCANALYSIS\-TEST 1 "17 Jan 2024" "0.8.0" "fccanalysis-test man page"
.SH NAME
fccanalysis\-test \- test FCCAnalyses framework
\fBfccanalysis\-test\fR \(en test FCCAnalyses framework
.SH SYNOPSIS
.sp
.nf
\fIfccanalysis test\fR [\-h | \-\-help] [-R TESTS_REGEX] [-E EXCLUDE_REGEX]
.fi
.sp
.B fccanalysis test
[\fB\-h\fR | \fB\-\-help\fR]
[\fB\-R\fR \fITESTS_REGEX\fR]
[\fB\-E\fR \fIEXCLUDE_REGEX\fR]
[\fB\-j\fR \fIPARALLEL\fR]
.SH DESCRIPTION
\fIfccanalysis\-test\fR will test the whole or a part of the FCC analysis
framework\&.
.B fccanalysis\-test
will test the whole or a part of the FCC analysis framework\&.

It is not intended as a replacement for running \fIctest\fR command directly in
the build directory, it is just convenience shortcut.
.SH OPTIONS
.PP
\-h, \-\-help
.RS 4
.TP
.BR \-h ", " \-\-help
Prints short help message and exits\&.
.RE
.PP
[test_regex]
.RS 4
.TP
\fB\-R\fR \fITESTS_REGEX\fR
Specify subset of tests to be run\&.
.RE
.TP
\fB\-E\fR \fIEXCLUDE_REGEX\fR
Specify subset of tests to ignore\&.
.TP
\fB\-j\fR \fIPARALLEL\fR, \fB\-\-parallel\fR \fIPARALLEL\fI
Number of tests running in parallel (equivalent to `ctest -j`)\&.
.SH SEE ALSO
fccanalysis(1), fccanalysis\-build(7), ctest(1)
.SH BUGS
Many
.SH AUTHORS
There are many contributors to the FCCAnalyses framework, but the principal
authors are:
.br
.RS 4
.in +4
Clement Helsens
.br
Valentin Volk
.br
Gerardo Ganis
.RE
.SH FCCANALYSES
Part of the FCCAnalyses framework\&.
.SH LINKS
.PP
1\&. FCCAnalyses webpage
.RS 4
https://hep-fcc\&.github\&.io/FCCAnalyses/
.RE
.UR https://hep-fcc\&.github\&.io/FCCAnalyses/
FCCAnalyses webpage
.UE
.PP
2\&. FCCAnalysises GitHub repository
.RS
https://github\&.com/HEP\-FCC/FCCAnalyses/
.RE
.UR https://github\&.com/HEP\-FCC/FCCAnalyses/
FCCAnalysises GitHub repository
.UE
.PP
3\&. FCCSW Forum
.RS
https://fccsw\-forum\&.web\&.cern\&.ch/
.RE
.UR https://fccsw\-forum\&.web\&.cern\&.ch/
FCCSW Forum
.UE
.SH CONTACT
.pp
.MT [email protected]
FCC-PED-SoftwareAndComputing-Analysis
.ME
Loading

0 comments on commit cbe6ff3

Please sign in to comment.