File: man.patch

package info (click to toggle)
voro%2B%2B 0.5%2Brevert-to-0.4.6%2Bdfsg1-1
  • links: PTS, VCS
  • area: main
  • in suites: bookworm, bullseye, sid, trixie
  • size: 1,368 kB
  • sloc: cpp: 6,384; perl: 232; makefile: 164
file content (275 lines) | stat: -rw-r--r-- 7,764 bytes parent folder | download | duplicates (2)
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
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
Author: Roger Wesson <rw@nebulousresearch.org>
Description: fixes spelling error and encloses .IP entries in quotes
--- a/man/voro++.1
+++ b/man/voro++.1
@@ -82,14 +82,14 @@
 The utility accepts the following basic options:
 
 .B
-.IP \-c <string>
+.IP "\-c <string>"
 This option allows the format of the output file to be customized to hold a
 variety of statistics about the computed Voronoi cells. The specified string
 can contain regular characters, plus control sequences beginning with
 percentage signs that are expanded to contain different Voronoi cell
 statistics. See below for a full custom output reference.
 .B
-.IP \-g
+.IP "\-g"
 If this option is specified, then an additional output file is generated with
 the ".gnu" extension, which contains a description of all the cells in a format
 that can be viewed using gnuplot using the
@@ -97,15 +97,15 @@
 command. Caution: For large input files, the gnuplot output file will be
 extremely large, so this option is best used on smaller systems.
 .B
-.IP \-h or \-\-help
+.IP "\-h or \-\-help"
 This option prints out a summary of the command syntax and the available
 options.
 .B
-.IP \-hc
+.IP "\-hc"
 This option prints out all the available control sequences for the customized
 output.
 .B
-.IP -l <len>
+.IP "-l <len>"
 Manually specify a typical length scale between particles, with which to
 configure the internal grid size. For example, if the particles represent
 densely-packed hard spheres of diameter d, then d would be an appropriate value
@@ -114,62 +114,62 @@
 can be set up immediately, and it is not necessary to temporarily store the
 input file contents while estimating the grid size.
 .B
-.IP -m <mem>
+.IP "-m <mem>"
 Manually specify the initial number of particles that can be stored in each
 block. By default a value of 8 is used. For any block where this limit is
-reached, the code will dynamically allocate more memory as neccessary, so
+reached, the code will dynamically allocate more memory as necessary, so
 usually it is not necessary to alter this.
 .B
-.IP -n <nx> <ny> <nz>
+.IP "-n <nx> <ny> <nz>"
 Manually specify the internal computational grid to have nx, ny, and nz blocks
 in the x, y, and z directions respectively, giving nx*ny*nz blocks in total.
 Manually specifying the size will result in a small performance boost, since
 the internal grid can be set up immediately, and it is not necessary to
 temporarily store the input file contents while estimating the size.
 .B
-.IP \-o
+.IP "\-o"
 Ensure that particles in the output file are in the same order as those in the
 input file. This may result in a very small increase in memory usage and
 execution time, and is turned off by default.
 .B
 .B
-.IP \-p
+.IP "\-p"
 Make the container periodic in all three coordinate directions.
 .B
-.IP \-px
+.IP "\-px"
 Make container periodic in the x direction.
 .B
-.IP \-py
+.IP "\-py"
 Make container periodic in the y direction.
 .B
-.IP \-pz
+.IP "\-pz"
 Make container periodic in the z direction.
 .B
-.IP \-r
+.IP "\-r"
 Carry out a Voronoi tessellation for a polydisperse particle arrangement using
 the radical Voronoi tessellation. For this case, an extra column is required in
 the input file, that contains the particle radii. The radii are also included
 in the output file.
 .B
-.IP \-v
+.IP "\-v"
 Verbose output. After the computation is completed, some statistics are printed
 about the container geometry, the internal computational grid, the number of
 particles imported, the number Voronoi cells computed, and the volume of the
 computed Voronoi cells.
 .B
-.IP \-\-version
+.IP "\-\-version"
 Print version information.
 .B
-.IP \-y
+.IP "\-y"
 Save the particles in POV-Ray format to "filename_p.pov" and the Voronoi cells
 in POV-Ray format to "filename_v.pov". Caution: For large input files, the
 POV-Ray Voronoi cell file will be extremely large, so this option is best used
 on smaller systems.
 .B
-.IP \-yp
+.IP "\-yp"
 Save the particles in POV-Ray format to "filename_p.pov".
 .B
-.IP \-yv
+.IP "\-yv"
 Save the Voronoi cells in POV-Ray format to "filename_v.pov".
 
 .SH OPTIONS FOR WALLS
@@ -178,26 +178,26 @@
 process. At present, four wall types are supported:
 
 .B
-.IP \-wb <x1> <x2> <x3> <x4> <x5> <x6>
+.IP "\-wb <x1> <x2> <x3> <x4> <x5> <x6>"
 Add six plane wall objects to make a box containing the space x1<x<x2, x3<y<x4,
 and x5<z<z6. This can be useful for embedding a smaller box within a larger
 container, in cases when the influence of particles outside the smaller box
 still need to be considered. This option is shorthand to avoid using the \-wp
 option six times.
 .B
-.IP \-wc <x1> <x2> <x3> <x4> <x5> <x6> <x7>
+.IP "\-wc <x1> <x2> <x3> <x4> <x5> <x6> <x7>"
 Add a cylindrical wall object, where (x1,x2,x3) is a point on the cylinder
 axis, (x4,x5,x6) is a vector along the cylinder axis, and x7 is the cylinder
 radius.
 .B
-.IP \-wo <x1> <x2> <x3> <x4> <x5> <x6> <x7>
+.IP "\-wo <x1> <x2> <x3> <x4> <x5> <x6> <x7>"
 Add a conical wall object, with apex at (x1,x2,x3), axis along (x4,x5,x6), and
 half angle x7 (specified in radians).
 .B
-.IP \-ws <x1> <x2> <x3> <x4>
+.IP "\-ws <x1> <x2> <x3> <x4>"
 Add a spherical wall object, centered on (x1,x2,x3), with radius x4.
 .B
-.IP \-wp <x1> <x2> <x3> <x4>
+.IP "\-wp <x1> <x2> <x3> <x4>"
 Add a plane wall object, with normal (x1,x2,x3), and displacement x4.
 
 Each wall is accounted for using a single approximating plane; several of the
@@ -219,22 +219,22 @@
 Particle-related entries:
 
 .B
-.IP %i
+.IP "%i"
 The particle ID number.	
 .B
-.IP %x
+.IP "%x"
 The x coordinate of the particle.
 .B
-.IP %y
+.IP "%y"
 The y coordinate of the particle.
 .B
-.IP %z
+.IP "%z"
 The z coordinate of the particle.
 .B
-.IP %q
+.IP "%q"
 The position vector of the particle, short for "%x %y %z".
 .B
-.IP %r
+.IP "%r"
 The radius of the particle (only printed if the polydisperse information is
 available).
 
@@ -242,21 +242,21 @@
 Vertex-related entries:
 
 .B
-.IP %w
+.IP "%w"
 The number of vertices in the Voronoi cell.
 .B
-.IP %p
+.IP "%p"
 A list of the vertices of the Voronoi cell in the format (x,y,z), relative to
 the particle center.
 .B
-.IP %P
+.IP "%P"
 A list of the vertices of the Voronoi cell in the format (x,y,z), relative to
 the global coordinate system.
 .B
-.IP %o
+.IP "%o"
 A list of the orders of each vertex.
 .B
-.IP %m
+.IP "%m"
 The maximum radius squared of a vertex position, relative to the particle
 center.
 
@@ -264,41 +264,41 @@
 Edge-related entries:
 
 .B
-.IP %g
+.IP "%g"
 The number of edges of the Voronoi cell.
 .B
-.IP %E
+.IP "%E"
 The total edge distance.
 .B
-.IP %e
+.IP "%e"
 A list of perimeters of each face.
 
 .PP
 Face-related entries:
 
 .B
-.IP %s
+.IP "%s"
 The number of faces of the Voronoi cell.
 .B
-.IP %F
+.IP "%F"
 The total surface area of the Voronoi cell.
 .B
-.IP %A
+.IP "%A"
 A frequency table of the orders of the faces.
 .B
-.IP %a
+.IP "%a"
 A list of the orders of the faces, showing how many edges make up each face.
 .B
-.IP %f
+.IP "%f"
 A list of areas of each face.
 .B
-.IP %t
+.IP "%t"
 A list of bracketed sequences of vertices that make up each face.
 .B
-.IP %l
+.IP "%l"
 A list of normal vectors for each face.
 .B
-.IP %n
+.IP "%n"
 A list of the neighboring particle or wall IDs corresponding to each face. The
 list can contain negative numbers. For the non-periodic case these correspond
 to when the particles have faces created by the edges of the computational
@@ -324,13 +324,13 @@
 .PP
 Volume-related entries:
 .B
-.IP %v
+.IP "%v"
 The volume of the Voronoi cell.
 .B
-.IP %c
+.IP "%c"
 The centroid of the Voronoi cell, relative to the particle center.
 .B
-.IP %C
+.IP "%C"
 The centroid of the Voronoi cell, in the global coordinate system.