doc/man/manTemplates/autoPatch.1.in

   1 '\" t
   2 .\"     Title: @UP@AUTOPATCH
   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@AUTOPATCH" "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@autoPatch \- Divides external faces into patches based on (user supplied) feature angle\&.
  23 .SH "SYNOPSIS"
  24 .sp
  25 \fB@EXECUTABLE_PREFIX@autoPatch\fR \fI<feature angle [0\-180]>\fR [\-overwrite] [\-case \fI<dir>\fR] [\-help] [\-doc] [\-srcDoc] [\-help] [\-doc] [\-srcDoc]
  26 .SH "DESCRIPTION"
  27 .sp
  28 \fBTODO\fR extended description
  29 .SH "OPTIONS"
  30 .PP
  31 \fI<feature angle [0\-180]>\fR
  32 .RS 4
  33
  34 \fBTODO\fR
  35 Detailed description of argument\&.
  36 .RE
  37 .PP
  38 \fB\-overwrite\fR
  39 .RS 4
  40 Overwrite existing data\&.
  41 .RE
  42 .PP
  43 \fB\-case\fR \fI<dir>\fR
  44 .RS 4
  45 Case directory\&.
  46 .RE
  47 .PP
  48 \fB\-help\fR
  49 .RS 4
  50 Display help message\&.
  51 .RE
  52 .PP
  53 \fB\-doc\fR
  54 .RS 4
  55 Display Doxygen API documentation page for this application\&.
  56 .RE
  57 .PP
  58 \fB\-srcDoc\fR
  59 .RS 4
  60 Display Doxygen source documentation page for this application\&.
  61 .RE
  62 .SH "SEE ALSO"
  63 .sp
  64 An overview of FreeFOAM is given in \fBfreefoam\fR(7)\&. For information on the configuration of FreeFOAM, refer to \fBfreefoam-config\fR(7)\&.
  65 .SH "AUTHOR"
  66 .sp
  67 OpenCFD Ltd\&.
  68 .SH "FREEFOAM"
  69 .sp
  70 Part of the \fBfreefoam\fR(7) suite\&.
  71 .SH "COPYRIGHT"
  72 .SS "Copyright \(co 2009 Michael Wild\&."
  73 .sp
  74 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
  75 .SS "Copyright \(co 1991\-2009 OpenCFD Ltd\&."
  76 .sp
  77 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
  78 .SS "Copyright \(co 2008\-2009 Michael Wild\&."
  79 .sp
  80 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