ogamesim.6: Bad NAME section, some corrections to the manual

Bug #1072428 reported by Bjarnig Ingi Gislason on 2012-10-28
6
This bug affects 1 person
Affects Status Importance Assigned to Milestone
ogamesim (Ubuntu)
Undecided
Unassigned

Bug Description

Software: ogamesim
Version: 1.17.1
File: ogamesim.6
Patch: Yes

  Warning from "lexgrog":

lexgrog: ogamesim.6.gz: parse failed

  Some formatting and spelling corrections

#
  Output from "nroff" should (usually) have only the left margin
adjusted (".ad l"). Otherwise the space between words can be too long.

  Output for a manual should (usually) have the right margin ragged
(".ad l"), as it is not (usually) intended for a book or other
professional printing medium.

#
  Each sentence should begin in a new line.

a) The space between sentences is different between formatters.

b) Changes in one line do then not affect others, and do therefore not
appear as changed in the output of "diff".

#
  Sometimes a small change in space between a roman and an italic
character is needed (use ".RI" or ".IR" macros).

#
  Remove spaces at end of lines.

#
  Protect the last full stop (period) in abbreviations or ellipses
(with \&) if it is not at the end of a sentence.

#
  Protect the full stop (period) at the beginning of text (word) or
ellipsis.

#
  Protect a single quote (', apostrophe) (with \&) at the start of the
quoted text.

##

ProblemType: Bug
Architecture: amd64
Date: Sun Oct 28 18:32:32 2012
Dependencies:
 coreutils 7.4-2ubuntu3
 debconf 1.5.28ubuntu4
 debconf-i18n 1.5.28ubuntu4
 dpkg 1.15.5.6ubuntu4.6
 findutils 4.4.2-1ubuntu1
 gcc-4.4-base 4.4.3-4ubuntu5.1
 libacl1 2.2.49-2
 libattr1 1:2.4.44-1
 libc-bin 2.11.1-0ubuntu7.11
 libc6 2.11.1-0ubuntu7.11
 libgcc1 1:4.4.3-4ubuntu5.1
 liblocale-gettext-perl 1.05-6
 libselinux1 2.0.89-4
 libstdc++6 4.4.3-4ubuntu5.1
 libtext-charwidth-perl 0.04-6
 libtext-iconv-perl 1.7-2
 libtext-wrapi18n-perl 0.06-7
 lzma 4.43-14ubuntu2
 perl-base 5.10.1-8ubuntu2.1
 tzdata 2012e-0ubuntu0.10.04
DistroRelease: Ubuntu 10.04
Package: ogamesim 1.17-1
PackageArchitecture: amd64
ProcEnviron:
 PATH=(custom, no user)
 LOCPATH=/var/tmp/username/lib/locale
 LANG=is_IS.ISO-8859-1
 SHELL=/bin/csh
ProcVersionSignature: Ubuntu 2.6.35-25.44~lucid1-generic 2.6.35.10
SourcePackage: ogamesim
Tags: lucid
Uname: Linux 2.6.35-25-generic x86_64

  Patch:

--- ogamesim.6 2012-10-28 18:23:00.374160934 +0000
+++ ogamesim.6.new 2012-10-28 18:42:24.094997279 +0000
@@ -1,33 +1,34 @@
 .TH ogamesim 6 "Dec 4, 2006" "ogamesim"
 .SH NAME
-Console Ogame Simulator
-.SH SYNOPSYS
-.B ogamesim [ -i <task.txt> ] [ -o <result.txt> ]
+ogamesim \- Console game Simulator
+.SH SYNOPSIS
+.B ogamesim [ \-i <task.txt> ] [ \-o <result.txt> ]
 .SH DESCRIPTION
 .PP
 Tasks for simulation are consist of text files.
 .PP
 Example of task concluding all possible units is adduced bellow.
 .SH OPTIONS
-.B -i <input file>:
+.B \-i <input file>:
 task file (STDIN unless defined);
 .PP
-.B -o <output file>:
+.B \-o <output file>:
 result file (STDOUT unless defined);
 .PP
-.B -s <iterations count>:
+.B \-s <iterations count>:
 1 <= value <= N (no limits);
 .PP
-.B -t <max simulation time>:
+.B \-t <max simulation time>:
 (seconds) 0 <= value <= N, 0=no limits;
 .PP
-.B -f <forks count>:
+.B \-f <forks count>:
 0 <= value <= 100.
 .SH RETURN VALUES
 .B 0:
 if success
 .SH EXAMPLES
 Task concluding all possible units:
+.ft C
 .nf
 attacker
         attack = 9
@@ -70,3 +71,4 @@
         crystal = 56789
         deut = 987654
 .fi
+.ft

To post a comment you must log in.
This report contains Public information  Edit
Everyone can see this information.

Other bug subscribers