Add clav-mutation-find to installation
[clav.git] / clav-sdl.1
blob482a25c928b246f101f87b6809ffe73e1df3b4b2
1 .Dd 2016-12-30
2 .Dt CLAV-SDL 1
3 .Os
4 .Sh NAME
5 .Nm clav-sdl
6 .Nd Visualize quivers with SDL
7 .Sh SYNOPSIS
8 .Nm
9 .Sh DESCRIPTION
10 .Nm
11 is a graphical program to interact with quivers.  It is similar to
12 Keller's Java applet, which is published at
13 https://webusers.imj-prg.fr/~bernhard.keller/quivermutation/ , though
14 .Nm
15 handles extensions such as half-weight edges and fat vertices.
16 .Sh INFORMATION
17 starts, it shows a sample quiver, which does not have many interesting
18 properties. Hovering over a vertex or an edge will display relevant
19 information in the top right corner.
20 .Pp
21 For convenience, edges are classified by color into three types, depending
22 on the specific edge weights they represent.
23 .Pp
24 .Bl -tag -width Ds
25 .It black
26 A black edge from vertex
27 .Ar i
29 .Ar j
30 has weights
31 .Dl ε_{ij} = ± d_{j} / GCD(d_{i}, d_{j}) 
32 .Dl ε_{ji} = ∓ d_{i} / GCD(d_{i}, d_{j}) 
33 where the signs are determined by the arrow's direction.
34 .It gray
35 A gray edge has half the edge weights that it would have if it were black.
36 .It red
37 A red edge has any other weights.  In general, red edges are rare during
38 .Sq interesting
39 mutation sequences.
40 .El
41 .Sh CONTROL
42 When
43 .Nm
44 The following controls are available. To cancel an action when input is
45 prompted for, press
46 .Sq ESC .
47 .Bl -tag -width Ds
48 .It Click+Drag
49 Clicking and dragging a vertex will reposition it onscreen. Clicking
50 and dragging empty space will reposition the entire quiver.
51 .It m
52 To mutate
53 .Po See
54 .Xr clav 1
55 for references
56 .Pc at a vertex, press
57 .Sq m ,
58 then click on the vertex.
59 .It v
60 To create a new vertex, press
61 .Sq v ,
62 then click where it should be placed. You will probably want to rename
63 it with
64 .Sq r .
65 .It d
66 To delete an edge or a vertex, press
67 .Sq d ,
68 then click the edge or vertex which should be deleted.
69 .It e
70 To add an edge
71 .Pq create a black edge if no edge is present, or add to an edge if one is present
72 between two vertices, press
73 .Sq e ,
74 then click the start and end vertices.
75 .It h
77 .Sq e ,
78 but with half weight.
79 .It f
80 To increase the fatness of a vertex, press
81 .Sq f ,
82 then click the vertex.  This may change how edges of that vertex are
83 calculated. The maximum fatness is system-dependent but
84 .Sq interesting
85 things tend to happen with low fatness.
86 .It g
88 .Sq f ,
89 but the vertex's fatness is decreased.  The minimum fatness is 1.
90 .It r
91 To rename a vertex, press
92 .Sq r ,
93 then click the vertex to be renamed. The new name will be prompted
94 for. If the system has a unicode-compatible IME, entering unicode
95 characters should work without issue.
96 .It s
97 To save the current quiver, press
98 .Sq s .
99 Depending on which packages are installed on the system, the filename
100 will be prompted for in one of a few ways. The following graphical file
101 choosers are known and probed for
102 .Pq in this order :
103 .Bl -bullet -compact
105 KDialog
107 Qarma
111 Zenity
113 Xdialog
115 If none is found, the filename will be prompted for onscreen. This prompt
116 is rather primitive, however.
117 .It l
118 To load a quiver
119 .Pq and to discard the current quiver ,
120 press
121 .Sq l .
122 A file will be prompted for in the same manner as the save dialog.
124 .Sh EXAMPLES
125 Example quivers may have been installed along with this program,
126 typically in
127 .Pa /usr/share/clav/ .
128 .Sh SEE ALSO
129 .Xr clav 1
130 .Xr clav-cli 1
131 .Sh BUGS
132 Edge weights are, for performance reasons
133 .Po see
134 .Xr clav-mutation-find 1
135 .Pc , stored as fractions with
136 numerator and denominator in system-dependent ranges.  While it probably
137 will not be an issue for
138 .Sq interesting
139 usage, causing edge weights to increase arbitrarily will eventually cause
141 to compute an unrepresentable edge weight.  In this situation,
143 will terminate with a diagnostic message rather than display incorrect
144 results.
145 .Sh AUTHORS
146 .An S. Gilles Aq Mt sgilles@math.umd.edu