Package: bsdgames
Version: 2.17-22
Severity: normal
File: /usr/games/trek
Tags: patch

Dear Maintainer,

The manpage for trek(6) is extremely brief. This is by design as there
is full documentation in a troff file. Unfortunately, the manpage
neglects to explain how to read that documentation.

This bug affects the game's core usability as the manual is required
for playing the game. (For example, it's not very much fun if you
don't even know the polar coordinate system used).

I have fixed the man page so that it explains how to read the
documentation. Please see the attached patch.

I also suggest that a PDF copy of documentation be included in
/usr/share/doc/bsdgames/trek.pdf for people who may not have groff
installed.

-- System Information:
Debian Release: 8.4
  APT prefers oldstable-updates
  APT policy: (500, 'oldstable-updates'), (500, 'oldstable')
Architecture: i386 (i686)

Kernel: Linux 3.16.0-4-686-pae (SMP w/2 CPU cores)
Locale: LANG=en_US.UTF-8, LC_CTYPE=en_US.UTF-8 (charmap=UTF-8)
Shell: /bin/sh linked to /bin/dash
Init: systemd (via /run/systemd/system)

Versions of packages bsdgames depends on:
ii  libc6                 2.19-18+deb8u10
ii  libgcc1               1:4.9.2-10
ii  libncurses5           5.9+20140913-1+b1
ii  libstdc++6            4.9.2-10
ii  libtinfo5             5.9+20140913-1+b1
ii  wamerican [wordlist]  7.1-1

bsdgames recommends no packages.

bsdgames suggests no packages.

-- no debconf information
--- trek.6.orig	2017-09-08 08:36:27.834508115 -0700
+++ trek.6	2017-09-08 08:53:03.590360272 -0700
@@ -76,10 +76,6 @@
 .Pp
 In general, throughout the game, if you forget what is appropriate
 the game will tell you what it expects if you just type in a question mark.
-.Sh AUTHOR
-.An Eric Allman
-.Sh SEE ALSO
-.Pa /usr/share/doc/bsdgames/trek.me
 .Sh COMMAND SUMMARY
 .Bl -item -compact
 .It
@@ -138,3 +134,17 @@
 .It
 .Ic w Ns arp warp_factor
 .El
+.Sh AUTHOR
+.An Eric Allman
+.Sh SEE ALSO
+.Pp
+The complete documentation,
+.Em Trek
+by Eric Allman, is in
+.Pa /usr/share/doc/bsdgames/trek.me
+which can be viewed using
+.Dl cd /usr/share/doc/bsdgames
+.Dl zcat trek.me.gz | tbl | nroff -me | less -r
+.Pp
+Or you can create a PDF version of the documentation like so,
+.Dl zcat trek.me.gz | tbl | groff -me -Tpdf > ~/trek.pdf

Attachment: trek.pdf
Description: Adobe PDF document

Reply via email to