UPD: man-page templates for new Usage sections
[freefoam.git] / doc / man / manTemplates / surfacePointMerge.1.in
blob83186ffa75f6e550d18feda58797bcaa8ee24dc7
1 '\" t
2 .\"     Title: @UP@SURFACEPOINTMERGE
3 .\"    Author: [see the "AUTHOR" section]
4 .\" Generator: DocBook XSL Stylesheets v1.74.3 <http://docbook.sf.net/>
5 .\"      Date: 07/25/2009
6 .\"    Manual: FreeFOAM Manual
7 .\"    Source: FreeFOAM @FF_VERSION_FULL@
8 .\"  Language: English
9 .\"
10 .TH "@UP@SURFACEPOINTMERGE" "1" "07/25/2009" "FreeFOAM @FF_VERSION_FULL@" "FreeFOAM Manual"
11 .\" -----------------------------------------------------------------
12 .\" * set default formatting
13 .\" -----------------------------------------------------------------
14 .\" disable hyphenation
15 .nh
16 .\" disable justification (adjust text to left margin only)
17 .ad l
18 .\" -----------------------------------------------------------------
19 .\" * MAIN CONTENT STARTS HERE *
20 .\" -----------------------------------------------------------------
21 .SH "NAME"
22 @EXECUTABLE_PREFIX@surfacePointMerge \- Merges points on surface if they are within absolute distance\&.
23 .SH "SYNOPSIS"
24 .sp
25 \fB@EXECUTABLE_PREFIX@surfacePointMerge\fR \fI<Foam surface file>\fR \fI<(absolute) merge distance>\fR \fI<Foam output surface file>\fR [\-case \fI<dir>\fR] [\-help] [\-doc] [\-srcDoc] [\-help] [\-doc] [\-srcDoc]
26 .SH "DESCRIPTION"
27 .sp
28 Since absolute distance use with care!
29 .SH "OPTIONS"
30 .PP
31 \fI<Foam surface file>\fR
32 .RS 4
34 \fBTODO\fR
35 Detailed description of argument\&.
36 .RE
37 .PP
38 \fI<(absolute) merge distance>\fR
39 .RS 4
41 \fBTODO\fR
42 Detailed description of argument\&.
43 .RE
44 .PP
45 \fI<Foam output surface file>\fR
46 .RS 4
48 \fBTODO\fR
49 Detailed description of argument\&.
50 .RE
51 .PP
52 \fB\-case\fR \fI<dir>\fR
53 .RS 4
54 Case directory\&.
55 .RE
56 .PP
57 \fB\-help\fR
58 .RS 4
59 Display help message\&.
60 .RE
61 .PP
62 \fB\-doc\fR
63 .RS 4
64 Display Doxygen API documentation page for this application\&.
65 .RE
66 .PP
67 \fB\-srcDoc\fR
68 .RS 4
69 Display Doxygen source documentation page for this application\&.
70 .RE
71 .SH "SEE ALSO"
72 .sp
73 An overview of FreeFOAM is given in \fBfreefoam\fR(7)\&. For information on the configuration of FreeFOAM, refer to \fBfreefoam-config\fR(7)\&.
74 .SH "AUTHOR"
75 .sp
76 OpenCFD Ltd\&.
77 .SH "FREEFOAM"
78 .sp
79 Part of the \fBfreefoam\fR(7) suite\&.
80 .SH "COPYRIGHT"
81 .SS "Copyright \(co 2009 Michael Wild\&."
82 .sp
83 Permission is granted to copy, distribute and/or modify this document under the terms of the GNU Free Documentation License, Version 1\&.3 or any later version published by the Free Software Foundation; with no Invariant Sections, no Front\-Cover Texts, and no Back\-Cover Texts\&. A copy of the license is available from http://www\&.gnu\&.org/copyleft/fdl\&.html
84 .SS "Copyright \(co 1991\-2009 OpenCFD Ltd\&."
85 .sp
86 OpenFOAM is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version\&. A copy of the license is available from http://www\&.gnu\&.org/licenses/old\-licenses/gpl\-2\&.0\&.html
87 .SS "Copyright \(co 2008\-2009 Michael Wild\&."
88 .sp
89 FreeFOAM is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version\&. A copy of the license is available from http://www\&.gnu\&.org/licenses/old\-licenses/gpl\-2\&.0\&.html