~ubuntu-branches/ubuntu/quantal/rivet/quantal

« back to all changes in this revision

Viewing changes to debian/aida2flat.1

  • Committer: Package Import Robot
  • Author(s): Lifeng Sun
  • Date: 2012-06-04 00:23:54 UTC
  • Revision ID: package-import@ubuntu.com-20120604002354-hqdcr26y74z0z4qy
Tags: 1.8.0-1
Initial release (Closes: #636983)

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
1
.TH AIDA2FLAT "1" "June 2012" "Rivet" "User Commands"
 
2
.SH NAME
 
3
aida2flat \- Convert AIDA data files to a flat format
 
4
.SH SYNOPSIS
 
5
.B aida2flat
 
6
[\fIoptions\fR] \fIaidafile \fR[\fIaidafile2 \fR...]
 
7
.SH DESCRIPTION
 
8
Convert AIDA data files to a flat format which is more human\-readable then the
 
9
XML (and by default also plottable directly using make\-plots). The output is by
 
10
default written out to standard output unless the \fB\-\-split\fR, \fB\-\-smart\-output\fR,
 
11
\fB\-\-gnuplot\fR, or \fB\-\-output\fR options are specified. When specifying either input or
 
12
output filenames, a '\-' is used to refer to stdin or stdout as appropriate.
 
13
.PP
 
14
Histograms can also be filtered by AIDA path, using the \fB\-m\fR or \fB\-M\fR options for a
 
15
positive or negative regex pattern patch respectively.
 
16
.SH OPTIONS
 
17
.TP
 
18
\fB\-h\fR, \fB\-\-help\fR
 
19
show this help message and exit
 
20
.TP
 
21
\fB\-o\fR OUTPUT, \fB\-\-output\fR=\fIOUTPUT\fR
 
22
Write all histos to a single output file, rather than
 
23
the default writing to stdout. stdout can be
 
24
explicitly specified by setting '\-' as the output
 
25
filename. This option will be disregarded if \fB\-\-split\fR,
 
26
\fB\-\-smart\-output\fR, or \fB\-\-gnuplot\fR is specified.
 
27
.TP
 
28
\fB\-s\fR, \fB\-\-split\fR
 
29
Write each histo to a separate output file, with names
 
30
based on the histo path
 
31
.TP
 
32
\fB\-S\fR, \fB\-\-smart\-output\fR
 
33
Write to output files with names based on the
 
34
corresponding input filename. This option will be
 
35
disregarded if \fB\-\-split\fR is specified.
 
36
.TP
 
37
\fB\-g\fR, \fB\-\-gnuplot\fR
 
38
Provide output suitable for Gnuplot's 'plot "foo.dat"
 
39
with xye'. This option implies \fB\-\-split\fR and will
 
40
override \fB\-\-output\fR or \fB\-\-smart\-output\fR
 
41
.TP
 
42
\fB\-\-plotinfodir\fR=\fIPLOTINFODIR\fR
 
43
directory which may contain plot header information
 
44
.TP
 
45
\fB\-m\fR PATHPATTERNS, \fB\-\-match\fR=\fIPATHPATTERNS\fR
 
46
Only write out histograms whose $path/$name string
 
47
matches these regexes
 
48
.TP
 
49
\fB\-M\fR PATHUNPATTERNS, \fB\-\-unmatch\fR=\fIPATHUNPATTERNS\fR
 
50
Exclude histograms whose $path/$name string matches
 
51
these regexes
 
52
.SH AUTHOR
 
53
This manual page was written by Lifeng Sun <lifongsun@gmail.com> for the Debian system (but may be used by others).