← Back to branch summary

~ubuntu-branches/ubuntu/raring/g3data/raring

« back to all changes in this revision

Viewing changes to debian/g3data.sgml

  • Committer: Bazaar Package Importer
  • Author(s): Peter S Galbraith
  • Date: 2004-12-14 22:12:00 UTC
  • mfrom: (1.2.1 upstream) (2.1.1 warty)
  • Revision ID: james.westby@ubuntu.com-20041214221200-9c372jt3hu56i055
Tags: 1:1.4.0.1-1
http://bugs.debian.org/269136
* New upstream release (merges-in man page provided uptream, thanks!)
* Removed debian/g3data.sgml since now merged in package upstream.
* Bug fix: "g3data: 404 on http link in the package description", thanks
  to Fabrice Lorrain for reporting it and providing the new URL, now
  used in the copyright and package description (Closes: #269136).

Show diffs side-by-side

added added

removed removed

Lines of Context:
debian/g3data.sgml
1
 
<!doctype refentry PUBLIC "-//OASIS//DTD DocBook V4.1//EN" [
2
 
 
3
 
<!-- Process this file with docbook-to-man to generate an nroff manual
4
 
     page: `docbook-to-man manpage.sgml > manpage.1'.  You may view
5
 
     the manual page with: `docbook-to-man manpage.sgml | nroff -man |
6
 
     less'.  A typical entry in a Makefile or Makefile.am is:
7
 
 
8
 
manpage.1: manpage.sgml
9
 
        docbook-to-man $< > $@
10
 
  -->
11
 
 
12
 
  <!-- Fill in your name for FIRSTNAME and SURNAME. -->
13
 
  <!ENTITY dhfirstname "<firstname>Peter</firstname>">
14
 
  <!ENTITY dhsurname   "<surname>Galbraith</surname>">
15
 
  <!-- Please adjust the date whenever revising the manpage. -->
16
 
  <!ENTITY dhdate      "<date>September 25, 2001</date>">
17
 
  <!-- SECTION should be 1-8, maybe w/ subsection other parameters are
18
 
       allowed: see man(7), man(1). -->
19
 
  <!ENTITY dhsection   "<manvolnum>1</manvolnum>">
20
 
  <!ENTITY dhemail     "<email>psg@debian.org</email>">
21
 
  <!ENTITY dhusername  "Peter S Galbraith">
22
 
  <!ENTITY dhucpackage "<refentrytitle>G3DATA</refentrytitle>">
23
 
  <!ENTITY dhpackage   "g3data">
24
 
 
25
 
  <!ENTITY debian      "<productname>Debian GNU/Linux</productname>">
26
 
  <!ENTITY gnu         "<acronym>GNU</acronym>">
27
 
]>
28
 
 
29
 
<refentry>
30
 
  <refentryinfo>
31
 
    <address>
32
 
      &dhemail;
33
 
    </address>
34
 
    <author>
35
 
      &dhfirstname;
36
 
      &dhsurname;
37
 
    </author>
38
 
    <copyright>
39
 
      <year>2001</year>
40
 
      <holder>&dhusername;</holder>
41
 
    </copyright>
42
 
    &dhdate;
43
 
  </refentryinfo>
44
 
  <refmeta>
45
 
    &dhucpackage;
46
 
 
47
 
    &dhsection;
48
 
  </refmeta>
49
 
  <refnamediv>
50
 
    <refname>&dhpackage;</refname>
51
 
 
52
 
    <refpurpose>extract data from scanned graphs</refpurpose>
53
 
  </refnamediv>
54
 
  <refsynopsisdiv>
55
 
    <cmdsynopsis>
56
 
      <command>&dhpackage;</command>
57
 
 
58
 
      <arg><option>-max <replaceable>x y</replaceable></option></arg>
59
 
 
60
 
      <arg><option>-scale <replaceable>factor</replaceable></option></arg>
61
 
 
62
 
      <arg choice="plain"><REPLACEABLE>file</REPLACEABLE></ARG>
63
 
    </cmdsynopsis>
64
 
  </refsynopsisdiv>
65
 
  <refsect1>
66
 
    <title>DESCRIPTION</title>
67
 
 
68
 
    <para>This manual page documents briefly the
69
 
      <command>&dhpackage;</command> command.</para>
70
 
 
71
 
    <para><command>&dhpackage;</command> is a program that extracts data
72
 
    from scanned graphs.  For example, graphs are typically published in
73
 
    scientific journals without tables of the actual data; g3data makes the
74
 
    process of extracting these data easy.</para>
75
 
 
76
 
  </refsect1>
77
 
  <refsect1>
78
 
    <title>OPTIONS</title>
79
 
 
80
 
    <variablelist>
81
 
      <varlistentry>
82
 
        <term><option>-max <replaceable>x y</replaceable></option>
83
 
        </term>
84
 
        <listitem>
85
 
          <para> If picture is larger x-wise than x or y-wise than y, the
86
 
                 picture is scaled down accordingly.  Use this option to
87
 
                 limit the size of the <command>&dhpackage;</command>
88
 
                 window to fit your display.</para>
89
 
        </listitem>
90
 
      </varlistentry>
91
 
      <varlistentry>
92
 
        <term><option>-scale <replaceable>factor</replaceable></option>
93
 
        </term>
94
 
        <listitem>
95
 
          <para>Scales the picture size by factor. This parameter nullifies
96
 
                effect of the -max parameter.</para>
97
 
        </listitem>
98
 
      </varlistentry>
99
 
      <varlistentry>
100
 
        <term><replaceable>file</replaceable></term>
101
 
        <listitem>
102
 
          <para>The filename of the graph.  This parameter is required.
103
 
          Supported image formats: JPEG, GIF, PPM, PGM, XPM, PNG, TIFF,
104
 
          EIM.</para>
105
 
        </listitem>
106
 
      </varlistentry>
107
 
    </variablelist>
108
 
  </refsect1>
109
 
  <refsect1>
110
 
    <title>TESTING AND USAGE</title>
111
 
    <para>There are two testdata files included with the program: test1.gif
112
 
     and test2.gif. Their corresponding data can be found in test1.values
113
 
     and test2.values.</para>
114
 
 
115
 
    <para>To test the program, start it with the command <command>g3data
116
 
     test1.gif</command> or with <command>g3data test2.gif</command>. When
117
 
     the program has started, click on the button labelled <emphasis>Set
118
 
     point 1 on X axis</emphasis> and lay out the corresponding point on
119
 
     the image by pressing on it. Do the same for point 2 on the X axis and
120
 
     points 1 and 2 on the Y axis. The axis points can also be layed out by
121
 
     pressing the middle mouse button for the x axis and the right button
122
 
     for the y axis. Fill out the entry boxes for the values of the axis
123
 
     points.  Then continue to lay out the desired data points on the graph
124
 
     itself.</para>
125
 
 
126
 
    <para>If by accident you lay out a data point where it doesn't belong,
127
 
     you can remove it by pressing the <emphasis>Remove last
128
 
     point</emphasis> button. To remove all layed out data points, press the
129
 
     <emphasis>Remove all points</emphasis> button. The axis points can be
130
 
     reset by pressing the corresponding button.</para>
131
 
 
132
 
    <para>After all the points been layed out, press the <emphasis>Print
133
 
     data</emphasis> button and the coordinates of the data will be printed
134
 
     out through stdout.  If you'd like to write the data to a file, fill
135
 
     out the filename entry box and press the <emphasis>Print to
136
 
     file</emphasis> button.</para>
137
 
 
138
 
    <para>Remember to apply the logarithmic scale on x axis for
139
 
     test2.gif.</para>
140
 
  </refsect1>
141
 
  <refsect1>
142
 
    <title>AUTHOR</title>
143
 
 
144
 
    <para><command>&dhpackage;</command> is written and maintained by Jonas
145
 
    Frantz jonas.frantz@helsinki.fi.  The <command>&dhpackage;</command>
146
 
    home page is</para>
147
 
 
148
 
    <LITERALLAYOUT>http://www.physics.helsinki.fi/~frantz/software/g3data.html</LITERALLAYOUT>
149
 
 
150
 
    <para>This manual page was written by &dhusername; &dhemail; for
151
 
      the &debian; system (but may be used by others).  Permission is
152
 
      granted to copy, distribute and/or modify this document under
153
 
      the terms of the <acronym>GNU</acronym> Free Documentation
154
 
      License, Version 1.1 or any later version published by the Free
155
 
      Software Foundation; with no Invariant Sections, no Front-Cover
156
 
      Texts and no Back-Cover Texts.</para>
157
 
 
158
 
  </refsect1>
159
 
</refentry>
160
 
 
161
 
<!-- Keep this comment at the end of the file
162
 
Local variables:
163
 
mode: sgml
164
 
sgml-omittag:t
165
 
sgml-shorttag:t
166
 
sgml-minimize-attributes:nil
167
 
sgml-always-quote-attributes:t
168
 
sgml-indent-step:2
169
 
sgml-indent-data:t
170
 
sgml-parent-document:nil
171
 
sgml-default-dtd-file:nil
172
 
sgml-exposed-tags:nil
173
 
sgml-local-catalogs:nil
174
 
sgml-local-ecat-files:nil
175
 
End:
176
 
-->