From owner-freebsd-ports Mon Aug 2 3:40:36 1999 Delivered-To: freebsd-ports@freebsd.org Received: from freefall.freebsd.org (freefall.FreeBSD.ORG [204.216.27.21]) by hub.freebsd.org (Postfix) with ESMTP id C2D0114C40 for ; Mon, 2 Aug 1999 03:40:32 -0700 (PDT) (envelope-from gnats@FreeBSD.org) Received: (from gnats@localhost) by freefall.freebsd.org (8.9.3/8.9.2) id DAA17496; Mon, 2 Aug 1999 03:40:01 -0700 (PDT) (envelope-from gnats@FreeBSD.org) Received: from nothing-going-on.demon.co.uk (nothing-going-on.demon.co.uk [193.237.89.66]) by hub.freebsd.org (Postfix) with ESMTP id CF8F214BEC for ; Mon, 2 Aug 1999 03:34:43 -0700 (PDT) (envelope-from nik@nothing-going-on.demon.co.uk) Received: (from nik@localhost) by nothing-going-on.demon.co.uk (8.9.3/8.9.3) id XAA58189; Sun, 1 Aug 1999 23:13:18 +0100 (BST) (envelope-from nik) Message-Id: <199908012213.XAA58189@nothing-going-on.demon.co.uk> Date: Sun, 1 Aug 1999 23:13:18 +0100 (BST) From: Nik Clayton Reply-To: nik@nothing-going-on.demon.co.uk To: FreeBSD-gnats-submit@freebsd.org X-Send-Pr-Version: 3.2 Subject: ports/12921: [PATCH] palm/xcopilot contains odd markup in man page Sender: owner-freebsd-ports@FreeBSD.ORG Precedence: bulk X-Loop: FreeBSD.org >Number: 12921 >Category: ports >Synopsis: [PATCH] palm/xcopilot contains odd markup in man page >Confidential: no >Severity: non-critical >Priority: low >Responsible: freebsd-ports >State: open >Quarter: >Keywords: >Date-Required: >Class: doc-bug >Submitter-Id: current-users >Arrival-Date: Mon Aug 2 03:40:00 PDT 1999 >Closed-Date: >Last-Modified: >Originator: Nik Clayton >Release: FreeBSD 3.2-STABLE i386 >Organization: C.R.F. Consulting ltd. >Environment: 3.2-STABLE >Description: It looks as though the xcopilot man page (xcopilot.1) is generated from source marked up in LinuxDoc, and then shipped with the distribution. The conversion from LinuxDoc isn't great, and the manpage that's installed by default looks like this; [...] SYNOPSIS xcopilot [lsqb ]-uU[rsqb ] [lsqb ]-debug [lsqb ]args[rsqb ][rsqb ] [lsqb ]-gdebug [lsqb ]args[rsqb ][rsqb ] [lsqb ]-bg color[rsqb ] [lsqb ]-bbg color[rsqb ] [lsqb ]-noxshm[rsqb ] [lsqb ]-serial pty- name[rsqb ] [lsqb ]-ramsize size[rsqb ] [lsqb ]-mag- factor factor[rsqb ] [lsqb ]-double[rsqb ] [lsqb ]-private[rsqb ] [lsqb ]-memversion version[rsqb ] [lsqb ]-reset[rsqb ] [...] Notice all the [lsqb ] and [rsqb ]. These are markup for 'left square bracket' and 'right square bracket' respectively. I'm not entirely sure whether or not man(1) is supposed to understand these or not. It doesn't on my system. Attached is a patch that replaces these codes with the literal characters. I've fixed; [lsqb ] -> [ [rsqb ] -> ] [tilde ] -> ~ [lt ] -> < [rt ] -> > This patch can be dropped in as patch-ab. If the maintainer could check this out and commit it I'd be grateful (or confirm that it works, and I'll commit it on their behalf if necessary). >How-To-Repeat: "man xcopilot" >Fix: Drop this in as ports/palm/xcopilot/patches/patch-ab. --- xcopilot.1.org Sun Aug 1 22:59:25 1999 +++ xcopilot.1 Sun Aug 1 23:03:41 1999 @@ -36,19 +36,19 @@ .SH SYNOPSIS .Pp -xcopilot [lsqb ]-uU[rsqb ] -[lsqb ]-debug [lsqb ]args[rsqb ][rsqb ] -[lsqb ]-gdebug [lsqb ]args[rsqb ][rsqb ] -[lsqb ]-bg \fIcolor\fP[rsqb ] -[lsqb ]-bbg \fIcolor\fP[rsqb ] -[lsqb ]-noxshm[rsqb ] -[lsqb ]-serial \fIptyname\fP[rsqb ] -[lsqb ]-ramsize \fIsize\fP[rsqb ] -[lsqb ]-magfactor \fIfactor\fP[rsqb ] -[lsqb ]-double[rsqb ] -[lsqb ]-private[rsqb ] -[lsqb ]-memversion \fIversion\fP[rsqb ] -[lsqb ]-reset[rsqb ] +xcopilot [-uU] +[-debug [args]] +[-gdebug [args]] +[-bg \fIcolor\fP] +[-bbg \fIcolor\fP] +[-noxshm] +[-serial \fIptyname\fP] +[-ramsize \fIsize\fP] +[-magfactor \fIfactor\fP] +[-double] +[-private] +[-memversion \fIversion\fP] +[-reset] .Pp .SH DESCRIPTION @@ -71,11 +71,11 @@ .nr bi 1 .Pp Display usage information -.IP "-debug [lsqb ]args[rsqb ]" +.IP "-debug [args]" .nr bi 1 .Pp Enter debug mode. No current arguments are supported. -.IP "-gdebug [lsqb ]args[rsqb ]" +.IP "-gdebug [args]" .nr bi 1 .Pp Enter gdb debug mode, where the optional argument is the TCP port or tty @@ -134,7 +134,7 @@ .Pp Directory where files generated/used by XCopilot are created or looked for if the corresponding environment varialbes don't specify a full -path. Default is [tilde ]/.xcopilot/ +path. Default is ~/.xcopilot/ .IP "XCOPILOTROM" .nr bi 1 .Pp @@ -164,7 +164,7 @@ .nr ll +1 .nr t\n(ll 2 .if \n(ll>1 .RS -.IP "[tilde ]/.xcopilot/" +.IP "~/.xcopilot/" .nr bi 1 .Pp Default directory for location of Pilot memory files (ROM/RAM/SCRATCH) @@ -203,7 +203,7 @@ .Pp \fBGetting Started\fP .Pp -Simplest way to get started is to create a directory [tilde ]/.xcopilot and +Simplest way to get started is to create a directory ~/.xcopilot and copy your pilot.rom file to that directory. Then, run xcopilot. You should see a shaped window resembling the Pilot appear on your X display. You should briefly see the ``Welcome to Pilot'' or similar @@ -260,11 +260,11 @@ .sp .ft RR .nf -linux:[tilde ] [gt ] telnet localhost 2000 +linux:~ > telnet localhost 2000 Trying 127.0.0.1... Connected to localhost. Escape character is ''. -command [gt ] +command > .DE .fi .ec @@ -311,7 +311,7 @@ .sp .ft RR .nf -xcopilot -serial [lsqb ]/dev/ptyqe[rsqb ] -gdebug [lsqb ]/dev/ptyqf[rsqb ] +xcopilot -serial [/dev/ptyqe] -gdebug [/dev/ptyqf] .DE .fi .ec @@ -391,7 +391,7 @@ .Pp XCopilot Home Page: http://xcopilot.cuspy.com/ .Pp -Unix Amiga Emulator: http://www.freiburg.linux.de/[tilde ]uae/ +Unix Amiga Emulator: http://www.freiburg.linux.de/~uae/ .Pp .SH DEVELOPMENT @@ -400,7 +400,7 @@ Copyright (C) 1995 Bernd Schmidt .Pp Original Copilot for Microsoft Windows 95 -Copyright (C) 1996 Greg Hewgill [lt ]greg@hewgill.com[gt ] +Copyright (C) 1996 Greg Hewgill .Pp http://www.hewgill.com/pilot/copilot/index.html .Pp @@ -408,7 +408,7 @@ http://palmpilot.3com.com/devzone/pose/seed.html .Pp The Original port of Copilot to X -Copyright (C) 1997 Ivan A. Curtis [lt ]icurtis@radlogic.com.au[gt ] +Copyright (C) 1997 Ivan A. Curtis .Pp Colormap support is Copyright (C) 1998 Cuspy Solutions, Inc. @@ -417,8 +417,8 @@ Long, C. Chan-Nui, Eric Howe and Gene McCulley. .Pp The current maintainer of XCopilot is Gene McCulley -[lt ]mcculley@cuspy.com[gt ] + .Pp -Bug Reports to [lt ]xcopilot@cuspy.com[gt ] +Bug Reports to .Pp .Pp >Release-Note: >Audit-Trail: >Unformatted: To Unsubscribe: send mail to majordomo@FreeBSD.org with "unsubscribe freebsd-ports" in the body of the message