File: ocamlgraph-editor.xml

package info (click to toggle)
ocamlgraph 2.2.0-2
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 2,624 kB
  • sloc: ml: 19,995; xml: 151; makefile: 14; sh: 1
file content (117 lines) | stat: -rw-r--r-- 4,578 bytes parent folder | download | duplicates (8)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN" 
"/usr/share/xml/docbook/schema/dtd/4.4/docbookx.dtd" [
  <!ENTITY debian              "Debian GNU/Linux">
  <!ENTITY dhprg               "<command>ocamlgraph-editor</command>">
]>

<!--**********************************************************************-->
<!-- ocamlgraph-editor manpage                                            -->
<!--                                                                      -->
<!-- Copyright (C) 2008 Sylvain Le Gall <gildor@debian.org>               -->
<!--                                                                      -->
<!-- This library is free software; you can redistribute it and/or        -->
<!-- modify it under the terms of the GNU Lesser General Public           -->
<!-- License as published by the Free Software Foundation; either         -->
<!-- version 2.1 of the License, or (at your option) any later version;   -->
<!-- with the OCaml static compilation exception.                         -->
<!--                                                                      -->
<!-- This library is distributed in the hope that it will be useful,      -->
<!-- but WITHOUT ANY WARRANTY; without even the implied warranty of       -->
<!-- MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU    -->
<!-- Lesser General Public License for more details.                      -->
<!--                                                                      -->
<!-- You should have received a copy of the GNU Lesser General Public     -->
<!-- License along with this library; if not, write to the Free Software  -->
<!-- Foundation, Inc., 51 Franklin St, Fifth Floor, Boston,               -->
<!-- MA 02110-1301, USA.                                                  -->
<!--                                                                      -->
<!-- Contact: gildor@debian.org                                           -->
<!--**********************************************************************-->

<refentry>

  <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="refentryinfo.xml"/>

  <refmeta>
    <refentrytitle>OCAMLGRAPH-EDITOR</refentrytitle>
    <manvolnum>1</manvolnum>
    <refmiscinfo class="software">OCamlGraph</refmiscinfo>
    <refmiscinfo class="manual">User Commands</refmiscinfo>
  </refmeta>

  <refnamediv>
    <refname>ocamlgraph-editor</refname>

    <refpurpose>GTK-based graph editor based on hyperbolic geometry.</refpurpose>
  </refnamediv>

  <refsynopsisdiv>
    <cmdsynopsis>
      &dhprg; 
      <arg>-dfs</arg>
      <arg>-bfs</arg>
      <arg>-rr <replaceable>refresh-rate</replaceable></arg>
      <arg>-aa</arg>
      <group>
        <arg>-help</arg>
        <arg>--help</arg>
      </group>
      <arg><replaceable>graph-file</replaceable></arg>
    </cmdsynopsis>
  </refsynopsisdiv>

  <refsect1>
    <title>DESCRIPTION</title>

    <para>This manual page documents briefly the &dhprg; command.</para>

    <para>This manual page was written for the &debian; distribution
      because the original program does not have a manual page.</para>

    <para>&dhprg; is an OCaml and GTK based graph editor based on hyperbolic geometry.</para>

    <variablelist>
      <varlistentry>
        <term><option>-dfs</option></term>
        <listitem>
          <para>DFS drawing strategy.</para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><option>-bfs</option></term>
        <listitem>
          <para>BFS drawing strategy.</para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><option>-rr <replaceable>refresh-rate</replaceable></option></term>
        <listitem>
          <para>Set the refresh rate, must be greater than 0.</para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><option>-aa</option></term>
        <listitem>
          <para>Turn off anti-aliased mode.</para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><option><replaceable>graph-file</replaceable></option></term>
        <listitem>
          <para>Files to edit.</para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><option>-help</option></term>
        <term><option>--help</option></term>
        <listitem>
          <para>Display an help message.</para>
        </listitem>
      </varlistentry>
    </variablelist>
    
  </refsect1>

  <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="license.xml"/>
</refentry>