File: man_help.html

package info (click to toggle)
munipack 0.6.2-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 33,104 kB
  • sloc: cpp: 29,677; sh: 4,909; f90: 2,872; makefile: 278; python: 140; xml: 72; awk: 12
file content (144 lines) | stat: -rw-r--r-- 3,500 bytes parent folder | download
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
<!DOCTYPE HTML>
<html lang="en">
<head>
<!-- meta -->
<meta http-equiv="content-type" content="text/html; charset=UTF-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<meta name="description" content="A general astronomical image processing software">
<meta name="author" content="Filip Hroch">
<link href="news_feed.xml" type="application/atom+xml" rel="alternate" title="Sitewide ATOM Feed" />
<link rel="stylesheet" href="munipack.css">
<link rel="shortcut icon" href="favicon.ico">
<title>Munipack ‒ Help</title>
</head>
<body>
<header>
  <a href="munipack.html"><img src="big_logo.png" alt="Munipack's logo" class="head"></a>
  <div class="headtitles">
    <p class="head">
      <a class="headtitle" href="munipack.html">Munipack</a>
    </p>
    <p class="head">
      <a class="headsubtitle" href="munipack.html">The astronomical image processing software</a>
    </p>
  </div>
  <div class="buttons">
    <a href="guide.html" class="button">
      <div class="bicon">
	📘
      </div>
      <div class="hide">
	Guide
      </div>
    </a>
    <a href="docs.html" class="button">
      <div class="bicon">
	📁
      </div>
      <div class="hide">
	Documents
      </div>
    </a>
  </div>
</header>
<section>

<h1>Help</h1>

<p class="abstract">
Munipack is distributed with an extensive help in HTML format.
An on-line help and manual pages are additional sources of documentation
primary intended for experienced users.
</p>

<h2>Reference Documentation</h2>

<p>
The main documentation of Munipack is included in distribution
and can be found in a local installation directory.
One can be considered as the reference documentation.
</p>

<p>
The documentation is available also world-wide:
</p>
<p class="download">
<a href="https://munipack.physics.muni.cz">Munipack homepage</a>
</p>

<p>
The binary distribution contains reference document tree under directory
<samp>/opt/munipack</samp>:
</p>
<p class="download">
<a href="file:////opt/munipack/share/doc/munipack-doc/munipack.html">/opt/munipack/share/doc/munipack/html</a>
</p>

<p>
The source distribution usually install reference document tree under directory
<samp>/usr</samp> (<samp>/usr/local</samp>):
</p>
<p class="download">
<a href="file:////usr/share/doc/munipack-doc/munipack.html">/usr/share/doc/munipack/html</a>
</p>


<h2>On-Line Help</h2>

<p>
On-line help system has two major modes ‒ global ‒ and ‒ action ‒ oriented
to get summary of all actions or to get detailed help about a selected action.
</p>


<h3>Global Help</h3>

<p>
The global help is invoked by using of switch <samp>--help</samp> or shortly
as <samp>-h</samp> or run munipack with no action:
</p>
<code>
$ munipack --help
</code>

<h3>Help for Actions</h3>

<p>
A help print for an action is invoked as help together with the action:
</p>
<code>
$ munipack astrometry --help
</code>

<p>
To get list of actions, use global help (as in example above) and
select appropriate item.
</p>


<h3>Version and License</h3>

<p>
Both version and license are available with <samp>--version</samp> switch:
</p>
<code>
$ munipack --version
</code>

<h2>Manual Pages</h2>
<p>
Munipack installation provides manual pages for both graphical
and command-line interfaces. Pages contains just short description of usage.
</p>
<code>
$ man munipack
</code>

</section>
<footer>
  © 1997 – 2025
  <a href="https://integral.physics.muni.cz/" title="author's homepage"
   class="foot">Filip Hroch</a>
</footer>
</body>
</html>