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
|
\input texinfo
@comment %**start of header
@settitle FullSWOF-utils Reference Manual
@syncodeindex pg cp
@comment %**end of header
@copying
This document describes FullSWOF-utils, a set of utility scripts to be
used with the FullSWOF shallow flow solver.
Copyright @copyright{} 2019 Paul Garlick.
@quotation
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, with no Front-Cover Texts, and with no Back-Cover
Texts. A copy of the license is included in the section entitled
``GNU Free Documentation License''.
@end quotation
@end copying
@titlepage
@title FullSWOF-utils Reference Manual
@page
@vskip 0pt plus 1filll
@insertcopying
@end titlepage
@contents
@ifnottex
@node Top
@top FullSWOF-utils
Utility scripts for the FullSWOF shallow flow solver
@end ifnottex
@menu
* Installation:: Installing FullSWOF-utils.
* GNU Free Documentation License:: The license of this manual.
* Index:: Complete Index.
@end menu
@node Installation, GNU Free Documentation License, Top, Top
@comment node-name, next, previous, up
@chapter Installation
@cindex chapter, installation
The @emph{fullSWOF-utils} package comprises a single top-level directory
and several sub-directories. The package may be installed in the same
location as @emph{FullSWOF} itself or any other convenient location.
@menu
* Requirements::
* Cloning::
@end menu
@node Requirements, Cloning, Installation, Installation
@comment node-name, next, previous, up
@section Requirements
To install @emph{fullSWOF-utils} the following packages are required:
@itemize
@item
@url{https://git-scm.com/, Git}, the version control system.
@item
@url{https://www.gnu.org/software/texinfo/, Texinfo}, the GNU
documentation system.
@end itemize
@node Cloning, , Requirements, Installation
@comment node-name, next, previous, up
@section Cloning
FullSWOF-utils is maintained using git, the version control system. A
simple way to install the package is to clone the git repository. To do so,
first open a terminal window on a system that has git installed. Then,
from within a suitable working directory, execute the command:
@example
git clone http://cgit.tourbillion-technology.com/fullSWOF-utils
@end example
A directory named @emph{fullSWOF-utils} will be created. To complete
the installation first change directory to the new @emph{fullSWOF-utils}
directory. Then execute the command:
@example
make
@end example
This command will create the documentation for the package. The
documentation is available in two formats; GNU Info format and html.
The info file is located in the doc directory. The html files are
located in the manual directory. There are two versions.
@emph{fullswof-utils.html} contains the complete documentation set out
on one page. The subdirectory @emph{html_node} contains a top-level
@emph{index.html} file and a separate page for each node.
The info file may be read using the @command{info} program. The html
files may be read using any web browser.
@node GNU Free Documentation License
@appendix GNU Free Documentation License
@include fdl-1.3.texi
@node Index
@unnumbered Index
@printindex cp
@bye
Local Variables:
mode: texinfo
TeX-master: t
End:
|
