[GRASS-dev] [GRASS GIS] #3973: Link text useless in man page environment

GRASS GRASS developer
1

#3973: Link text useless in man page environment
-------------------------+-------------------------
Reporter: jidanni | Owner: grass-dev@…
     Type: defect | Status: new
Priority: trivial | Milestone:
Component: Docs | Version: unspecified
Keywords: | CPU: Unspecified
Platform: Unspecified |
-------------------------+-------------------------
These links are great, but not in a plain text man page
{{{
$ man r.mapcalc|col -b|sed /^SOURCE/,$\!d
SOURCE CODE
        Available at: r.mapcalc source code (history)

        Main index | Raster index | Topics index | Keywords index |
Graphical index | Full index

        © 2003-2019 GRASS Development Team, GRASS GIS 7.8.1 Reference
Manual
}}}

https://bugs.debian.org/cgi-bin/bugreport.cgi?bug=944413 says it is
upstream to blame.

--
Ticket URL: <https://trac.osgeo.org/grass/ticket/3973&gt;
GRASS GIS <https://grass.osgeo.org>

2

#3973: Link text useless in man page environment
--------------------------+-------------------------
  Reporter: jidanni | Owner: grass-dev@…
      Type: defect | Status: new
  Priority: trivial | Milestone: 7.8.2
Component: Docs | Version: unspecified
Resolution: | Keywords: g.manual
       CPU: Unspecified | Platform: Unspecified
--------------------------+-------------------------
Changes (by neteler):

* keywords: => g.manual
* milestone: => 7.8.2

Comment:

Yes, a long standing question (for us): how to add links to MAN manual
pages?

(can be seen with `g.manual -m <module>`

Pointers welcome!

--
Ticket URL: <https://trac.osgeo.org/grass/ticket/3973#comment:1&gt;
GRASS GIS <https://grass.osgeo.org>

3

#3973: Link text useless in man page environment
--------------------------+-------------------------
  Reporter: jidanni | Owner: grass-dev@…
      Type: defect | Status: new
  Priority: trivial | Milestone: 7.8.2
Component: Docs | Version: unspecified
Resolution: | Keywords: g.manual
       CPU: Unspecified | Platform: Unspecified
--------------------------+-------------------------

Comment (by neteler):

Yes, a long standing question (for us): how to add links to MAN manual
pages?

(can be seen with `g.manual -m <

Pointers welcome!

--
Ticket URL: <https://trac.osgeo.org/grass/ticket/3973#comment:2&gt;
GRASS GIS <https://grass.osgeo.org>

4

#3973: Link text useless in man page environment
--------------------------+-------------------------
  Reporter: jidanni | Owner: grass-dev@…
      Type: defect | Status: new
  Priority: trivial | Milestone: 7.8.2
Component: Docs | Version: unspecified
Resolution: | Keywords: g.manual
       CPU: Unspecified | Platform: Unspecified
--------------------------+-------------------------

Comment (by jidanni):

You would have to do something like
{{{
$ lynx -dump https://grass.osgeo.org/grass79/manuals/d.erase.html | tail
-n 33
SOURCE CODE

    Available at: [12]d.erase source code ([13]history)
      _________________________________________________________________

    [14]Main index | [15]Display index | [16]Topics index | [17]Keywords
    index | [18]Graphical index | [19]Full index

    © 2003-2019 [20]GRASS Development Team, GRASS GIS 7.9.dev Reference
    Manual

References

    1. https://grass.osgeo.org/grass79/manuals/index.html
    2. https://grass.osgeo.org/grass79/manuals/display.html
    3. https://grass.osgeo.org/grass79/manuals/topic_graphics.html
    4. https://grass.osgeo.org/grass79/manuals/keywords.html#monitors
    5. https://grass.osgeo.org/grass79/manuals/d.erase.html#description
    6. https://grass.osgeo.org/grass79/manuals/d.erase.html#see-also
    7. https://grass.osgeo.org/grass79/manuals/d.erase.html#author
    8. https://grass.osgeo.org/grass79/manuals/d.mon.html
    9. https://grass.osgeo.org/grass79/manuals/d.redraw.html
   10. https://grass.osgeo.org/grass79/manuals/d.rast.html
   11. https://grass.osgeo.org/grass79/manuals/d.vect.html
   12. https://github.com/OSGeo/grass/tree/master/display/d.erase
   13. https://github.com/OSGeo/grass/commits/master/display/d.erase
   14. https://grass.osgeo.org/grass79/manuals/index.html
   15. https://grass.osgeo.org/grass79/manuals/display.html
   16. https://grass.osgeo.org/grass79/manuals/topics.html
   17. https://grass.osgeo.org/grass79/manuals/keywords.html
   18. https://grass.osgeo.org/grass79/manuals/graphical_index.html
   19. https://grass.osgeo.org/grass79/manuals/full_index.html
   20. http://grass.osgeo.org/
}}}

or better yet put each URL right next to the link text.

Anyway, you need to put the URLs right into the man page.

--
Ticket URL: <https://trac.osgeo.org/grass/ticket/3973#comment:3&gt;
GRASS GIS <https://grass.osgeo.org>

5

#3973: Link text useless in man page environment
--------------------------+------------------------------------------------
  Reporter: jidanni | Owner: grass-dev@…
      Type: defect | Status: new
  Priority: trivial | Milestone: 7.8.2
Component: Docs | Version: unspecified
Resolution: | Keywords: g.manual g.html2man man URLs links
       CPU: Unspecified | Platform: Unspecified
--------------------------+------------------------------------------------
Changes (by wenzeslaus):

* keywords: g.manual => g.manual g.html2man man URLs links

Comment:

`[12]d.erase source code` and `[13]history` should be external URLs, but
`[14]Main index` and `[15]Display index` are internal within
documentation. Should they work more like in SEE ALSO?

--
Ticket URL: <https://trac.osgeo.org/grass/ticket/3973#comment:4&gt;
GRASS GIS <https://grass.osgeo.org>