Opened 8 years ago

Closed 8 years ago

Last modified 8 years ago

#6569 closed enhancement (wontfix)

Add SEE ALSO to man pages

Reported by: Dan Jacobson Owned by: warmerdam
Priority: normal Milestone:
Component: Docs Version: 2.1.0
Severity: normal Keywords:
Cc:

Description

Please make sure each man page has a standard nroff -man SEE ALSO section at the bottom, else using

$ dlocate -man gdal-bin
1 gdal_contour
1 gdal_grid
1 gdal_pansharpen
1 gdal_rasterize
1 gdal_translate
1 gdal_utilities
1 gdaladdo
1 gdalbuildvrt
1 gdaldem
1 gdalinfo
1 gdallocationinfo
1 gdalmanage
1 gdalsrsinfo
1 gdaltindex
1 gdaltransform
1 gdalwarp
1 gnm_utilities
1 gnmanalyse
1 gnmmanage
1 nearblack
1 ogr2ogr
1 ogr_utilities
1 ogrinfo
1 ogrlineref
1 ogrtindex

is the only way one can find out about the others, except for the last five.

By the way, I submitted six bugs to Debian, that were all closed.

http://bugs.debian.org/cgi-bin/pkgreport.cgi?pkg=gdal-bin;submitter=jidanni@jidanni

Also on man ogr2ogr it says

       More examples are given in the individual format pages.

but not tips on where to find them.

Change History (3)

comment:1 by Dan Jacobson, 8 years ago

Component: defaultDocs
Type: defectenhancement
Version: unspecified2.1.0

comment:2 by Even Rouault, 8 years ago

Resolution: wontfix
Status: newclosed

Online doc http://gdal.org/ should answer your questions. Closing as wontfix

comment:3 by Dan Jacobson, 8 years ago

That is a very good idea... _if_ you mention it on the man pages.

$ set $(dlocate -man gdal-bin | sed 's/1 //')
$ for i do echo -n "$i: "; man $i|fgrep -c gdal.org; done
gdal_contour: 0
gdal_grid: 0
gdal_pansharpen: 0
gdal_rasterize: 0
gdal_translate: 0
gdal_utilities: 0
gdaladdo: 0
gdalbuildvrt: 0
gdaldem: 0
gdalinfo: 0
gdallocationinfo: 0
gdalmanage: 0
gdalsrsinfo: 0
gdaltindex: 0
gdaltransform: 0
gdalwarp: 0
gnm_utilities: 0
gnmanalyse: 0
gnmmanage: 0
nearblack: 0
ogr2ogr: 0
ogr_utilities: 0
ogrinfo: 0
ogrlineref: 0
ogrtindex: 0

Just telling me will not let readers of the man pages know.

By the way. the point of the offline man pages is that they should be usable at remote sites offline...

Note: See TracTickets for help on using tickets.