discuss@mandoc.bsd.lv
 help / color / mirror / Atom feed
From: Jason McIntyre <jmc@kerhand.co.uk>
To: discuss@mdocml.bsd.lv
Subject: Re: desired .Bk semantics?
Date: Sat, 3 Jul 2010 17:52:25 +0100	[thread overview]
Message-ID: <20100703165249.GH20174@bramka.kerhand.co.uk> (raw)
In-Reply-To: <4C2F644F.3070307@bsd.lv>

On Sat, Jul 03, 2010 at 06:24:47PM +0200, Kristaps Dzonsons wrote:
> 
> Ingo and Jason,
> 
> I propose the following.  I've enclosed a patch that demonstrates this.
> 
> First, I disabled `Bk' completely.
> 
> Second, when `Op' or `Oo' is encountered with MDOC_SYNPRETTY (i.e., in a
> SYNOPSIS section or with ".nr nS 1"), spaces are made non-breaking.
> 
> Example (mandoc -Owidth=70 ssh.1):
> 
> SYNOPSIS
>      ssh [-1246AaCfgKkMNnqsTtVvXxYy] [-b bind_address]
>          [-c cipher_spec] [-D [bind_address:]port] [-e escape_char]
>          [-F configfile] [-I pkcs11] [-i identity_file]
>          [-L [bind_address:]port:host:hostport] [-l login_name]
>          [-m mac_spec] [-O ctl_cmd] [-o option] [-p port]
>          [-R [bind_address:]port:host:hostport] [-S ctl_path]
>          [-W host:port] [-w local_tun[:remote_tun]] [user@]hostname
>          [command]
> 
> Note: this is after removing the escaped spaces that the manual author
> had added here and there.
> 
> Example (mandoc -Owidth=70 spamd.8):
>      spamd [-45bdv] [-B maxblack] [-c maxcon]
>            [-G passtime:greyexp:whiteexp] [-h hostname] [-l address]
>            [-M address] [-n name] [-p port] [-S secs] [-s secs]
>            [-w window] [-Y synctarget] [-y synclisten]
> 
> This removes the `Bk' mess and gives a nice, regular algorithm for
> formatting in MDOC_SYNPRETTY.
> 
> It can/will be trivially extended to the function macros, Fa and Fn and
> family.
> 
> Thoughts?
> 

spiffing!

i wonder though about disabling Bk...do you mean it just ignores it, or
that the current Bk/Ek in files will cause a problem? i'm not averse to
removing them from pages, but i need to think about our pages being
formatted on another system. for example, for ssh.1 to have a fighting
chance on a non-mandoc system.

i don;t know how practical that is though. i haven;t thought very far
ahead about this. keep the keeps (er) or remove them...

jmc
--
 To unsubscribe send an email to discuss+unsubscribe@mdocml.bsd.lv

  reply	other threads:[~2010-07-03 16:52 UTC|newest]

Thread overview: 8+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2010-07-02 23:43 Ingo Schwarze
2010-07-03  6:54 ` Jason McIntyre
2010-07-03 12:27   ` Kristaps Dzonsons
2010-07-03 14:11     ` Jason McIntyre
2010-07-03 16:24       ` Kristaps Dzonsons
2010-07-03 16:52         ` Jason McIntyre [this message]
2010-07-03 17:25           ` desired .Bk semantics? [UPDATED PATCH] Kristaps Dzonsons
2010-07-03 17:28         ` desired .Bk semantics? Ingo Schwarze

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20100703165249.GH20174@bramka.kerhand.co.uk \
    --to=jmc@kerhand.co.uk \
    --cc=discuss@mdocml.bsd.lv \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).