[GRASS-user] GRASS scripts manual tab

GRASS GRASS user
1

Greetings all

I’ve been browsing around the Scripts and, for example i.tasscap /i.oif, has a fine and nice manual tab associated with the function (with pictures, text bla bla bla).
How can I do this manual pages to be associated with my own scripts?

Best regards
Franz

2

I think your question was answered here.

Bests
ƒacu.-

Markus Neteler neteler at osgeo.org
Sun Nov 1 11:11:20 EST 2009

3

Franz Schiller wrote:

I've been browsing around the Scripts and, for example i.tasscap /i.oif, has
a fine and nice manual tab associated with the function (with pictures, text
bla bla bla).
How can I do this manual pages to be associated with my own scripts?

It should appear automatically if there is a manual page at

  $GISBASE/docs/html/<scriptname>.html

If scripts are "built" using the GRASS Makefiles, the manual page will
be generated by merging the description.html file with the module and
option descriptions at the top of the script.

--
Glynn Clements <glynn@gclements.plus.com>

4

Thank Glynn
But if I just “write” a script a put it in /Scripts/ I will have to create a HTML page and put it in $GISBASE/docs/html/.html in order to have a manual right?

Regarding Built Scripts using GRASS makefiles, the structure would be something like this?

MODULE_TOPDIR = …/…
PGM =
include $(MODULE_TOPDIR)/include/Make/Script.make
default: script

?

Thanks you all

On Thu, Jan 28, 2010 at 1:19 PM, Glynn Clements <glynn@gclements.plus.com> wrote:

Franz Schiller wrote:

I’ve been browsing around the Scripts and, for example i.tasscap /i.oif, has
a fine and nice manual tab associated with the function (with pictures, text
bla bla bla).
How can I do this manual pages to be associated with my own scripts?

It should appear automatically if there is a manual page at

$GISBASE/docs/html/.html

If scripts are “built” using the GRASS Makefiles, the manual page will
be generated by merging the description.html file with the module and
option descriptions at the top of the script.

–
Glynn Clements <glynn@gclements.plus.com>

5

Franz Schiller wrote:

But if I just "write" a script a put it in /Scripts/ I will have to create a
HTML page and put it in $GISBASE/docs/html/<scriptname>.html in order to
have a manual right?

Right.

Regarding Built Scripts using GRASS makefiles, the structure would be
something like this?

MODULE_TOPDIR = ../..
PGM = <SCRIPT NAME>
include $(MODULE_TOPDIR)/include/Make/Script.make
default: script

Right.

If you do this, the HTML file should be named description.html (in
6.x) or <scriptname>.html (in 7.0), and shouldn't have the initial
<html><head>...</head><body> section or the final </body></html>.
Those will be added by the commands for the "script" target, along
with the descriptions for the options and a footer.

Any .jpg or .png files in the directory will also be installed to the
docs/html directory. On Windows, a batch file will also be created. In
7.0, an nroff manual page will be generated at the same time as the
HTML (in 6.x, these are all generated in a separate step at the end of
the build process).

See (almost) any of the existing scripts for reference (a few of them
are more complex, installing additional scripts or data files).

--
Glynn Clements <glynn@gclements.plus.com>