~ubuntu-branches/ubuntu/oneiric/ctioga2/oneiric

« back to all changes in this revision

Viewing changes to man/ctioga2.1.template

  • Committer: Bazaar Package Importer
  • Author(s): Vincent Fourmond
  • Date: 2011-01-24 21:36:06 UTC
  • Revision ID: james.westby@ubuntu.com-20110124213606-9ettx0ugl83z0bzp
Tags: upstream-0.1
ImportĀ upstreamĀ versionĀ 0.1

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
1
.\" -*- mode: nroff; -*-
 
2
.\" This is the template for the manual page of ctioga2
 
3
.\"
 
4
.\" Copyright 2009 by Vincent Fourmond
 
5
.\"
 
6
.\" This program is free software; you can redistribute it and/or modify
 
7
.\" it under the terms of the GNU General Public License as published by
 
8
.\" the Free Software Foundation; either version 2 of the License, or
 
9
.\" (at your option) any later version.
 
10
.\"  
 
11
.\" This program is distributed in the hope that it will be useful,
 
12
.\" but WITHOUT ANY WARRANTY; without even the implied warranty of
 
13
.\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 
14
.\" GNU General Public License for more details (in the COPYING file).
 
15
.\"
 
16
.\" write-header
 
17
 
 
18
.\" We want to use the .URL command
 
19
.\" .mso www.tmac
 
20
.\" Do we ??
 
21
 
 
22
.SH NAME
 
23
ctioga2 \- a command-line front-end for the Tioga plotting library
 
24
 
 
25
.SH SYNOPSIS
 
26
.B ctioga2
 
27
.I arguments
 
28
\&.\|.\|.
 
29
 
 
30
.SH DESCRIPTION
 
31
 
 
32
.B ctioga2
 
33
is a command-line front-end to the wonderful Tioga plotting
 
34
library. It aims at plotting quickly both data files and mathematical
 
35
functions, with however the possibility of a high control over the
 
36
details.
 
37
 
 
38
The main feature that was introduced compared to the old
 
39
.B ctioga
 
40
is that it is now possible to use command files for
 
41
.BR ctioga2 :
 
42
every single command-line option corresponds to a command, whose name
 
43
is written. Just give the command the same arguments as to the
 
44
command-line option. To read a command file, feed it to the 
 
45
.B -f 
 
46
command-line option.
 
47
 
 
48
.SH EXAMPLES
 
49
 
 
50
Here are a few examples, both from command-line and using the
 
51
corresponding files.
 
52
 
 
53
.TP 8 
 
54
.BI ctioga2 \ File.dat
 
55
Produces a file \fIPlot.pdf\fR showing the second column of File.dat
 
56
as a function of the first.
 
57
 
 
58
.P 
 
59
The corresponding command file would be:
 
60
 
 
61
  #!/usr/bin/env ctioga2 -f 
 
62
  plot(File.dat)
 
63
 
 
64
 
 
65
 
 
66
 
 
67
.SH OPTIONS
 
68
 
 
69
 
 
70
.\" write-commands
 
71
 
 
72
.SH TYPES
 
73
 
 
74
Most of the commands accept one or more arguments, which have
 
75
different types. Here are the meanings of those types.
 
76
 
 
77
.\" write-types
 
78
 
 
79
.SH ENVIRONMENT VARIABLES
 
80
 
 
81
If the environment variables
 
82
.B CTIOGA2_PRE
 
83
or
 
84
.B CTIOGA2_POST
 
85
are set, they are split into words according to shell rules (see the
 
86
Shellwords.shellwords ruby function for more information) and
 
87
prepended or appended to the command-line arguments. They don't leave
 
88
any trace in the actual command-line (so, for instance,
 
89
.B --echo
 
90
won't be aware of them).
 
91
 
 
92
.SH AUTHOR
 
93
 
 
94
.B ctioga2
 
95
was written by Vincent Fourmond.
 
96
.B Tioga
 
97
was written by Bill Paxton.
 
98
 
 
99
.SH BUGS
 
100
 
 
101
.B ctioga2
 
102
is most certainly not bug-free. You can use the facility at
 
103
.B rubyforge.org
 
104
to report any bug you notice:
 
105
.IR http://rubyforge.org/tracker/?group_id=8218 .
 
106
You can also use the same facility for feature requests and to provide
 
107
use with patches.
 
108
 
 
109
Alternatively, you can use the forums at
 
110
.I http://rubyforge.org/forum/?group_id=8218
 
111
or the 
 
112
.I ctioga2-users@rubyforge.org
 
113
mailing list to report any kind of problems or suggestions.
 
114
 
 
115
.SH "SEE ALSO"
 
116
 
 
117
.BR xpdf (1),
 
118
.BR pdflatex (1),
 
119
.BR open (1),
 
120
.BR gnuplot (1),
 
121
.BR ctioga "(1) (the original ctioga)"
 
122
 
 
123
The original tarball includes an 
 
124
.I examples/
 
125
with various examples demonstrating different features of 
 
126
.B ctioga2\fR, 
 
127
and in particular the different ways to use it: command-line or
 
128
command-file.
 
129
 
 
130
It also includes a
 
131
.I tests/
 
132
directory containing test shell scripts. Runnning these shell scripts
 
133
should give you a decent idea of 
 
134
.BR ctioga2 's
 
135
possibilities while assuring that it did install properly.
 
136
 
 
137
Useful information, documentation and most up-to-date news can be
 
138
found at
 
139
.BR ctioga2 's
 
140
website, at 
 
141
.IR http://ctioga2.rubyforge.org/ .
 
142
 
 
143
More information about 
 
144
.B Tioga
 
145
and its rdoc documentation can be found at
 
146
.IR http://www.kitp.ucsb.edu/~paxton/tioga.html .
 
147