Re: Plan 9 man added a new macro for man page references

2021-07-31 Thread Alejandro Colomar (man-pages)
Sorry for missing CCs. I'm new to this mailing list, and didn't know how to find the list of CCs. Hi Branden, [CCing Russ Cox out of the blue; Russ, I work on GNU roff] Hi folks, Plan 9 went and did an interesting thing[1]. They implemented a macro just for man page cross-references. As y

Re: Plan 9 man added a new macro for man page references

2021-08-01 Thread Alejandro Colomar (man-pages)
Hi, Branden! On 8/1/21 1:09 PM, G. Branden Robinson wrote: Hi, Alex! Welcome to the groff list! At 2021-07-31T16:54:43+0200, Alejandro Colomar (man-pages) wrote: Here's what I would have done differently or in addition. * Named the macro MR ("manual reference") to give it eve

Re: Plan 9 man added a new macro for man page references

2021-08-03 Thread Alejandro Colomar (man-pages)
Hi, Branden! On 8/1/21 1:09 PM, G. Branden Robinson wrote: I support this plan ;-) Cool! I'm glad to see some discussion about it...it would be _so nice_ to land this and OSC 8 hyperlinks for terminal emulators in grotty(1) for the next groff release. Those would be new features we could rea

Re: Plan 9 man added a new macro for man page references

2021-08-03 Thread Alejandro Colomar (man-pages)
Hi, Ingo! On 8/3/21 4:30 PM, Ingo Schwarze wrote: Hello Alejandro, Alejandro Colomar (man-pages) wrote on Tue, Aug 03, 2021 at 09:29:14AM +0200: Thinking about it twice... Given mdoc(7) already implemented that, and that the basic difference between mdoc(7) and man(7) is basically that man

Re: Plan 9 man added a new macro for man page references

2021-08-04 Thread Alejandro Colomar (man-pages)
Hi, Branden! On 8/4/21 10:57 AM, G. Branden Robinson wrote: [...] I pretty much share Dave Kemper's perspective on this, to which I would add, if mdoc were going to bury man(7) in the backyard, it's had 30 years to do so. Waiting longer is not going to clear man(7)'s problems off of our plate.

Re: What is our ChangeLog management policy?

2021-09-06 Thread Alejandro Colomar (man-pages)
Hi, On 9/6/21 11:45 PM, Keith Marshall wrote: I think having full details in one place is important, and guessing from what Keith, Branden, and myself said, it might be possible to reach consensus that git commit messages are a good place for that. I can agree to that. In fact, my own work-fl

.ad l/.ad b

2021-09-12 Thread Alejandro Colomar (man-pages)
Hi, Branden and Michael! I've seen these in shmctl.2, and didn't know what they mean. groff(7) wasn't very helpful. [ .SH SYNOPSIS .nf .ad l .B #include .PP .BI "int shmctl(int " shmid ", int " cmd ", struct shmid_ds *" buf ); .ad b .fi ] What are those '.ad X' and do we really need them? I f

.B, .I disable hyphenation?

2021-09-12 Thread Alejandro Colomar (man-pages)
Hi Branden, Usually, when a manual page highlights a term, either in bold or italics, it usually is a special identifier (macro, function, command name or argument), for which hyphenation can hurt readability and even worse, turn it into a different valid identifier. What about disabling hyp

Re: AW: .ad l/.ad b

2021-09-12 Thread Alejandro Colomar (man-pages)
Hi Oliver, On 9/12/21 1:33 PM, Oliver Corff wrote: Hi, .ad Begin line adjustment for output lines in current adjust mode. .ad c Start line adjustment in mode c (c=l,r,c,b,n). That looks like left, right, centered, block and neutral? Just my uninformed guess, and I am not at all sure about my

Re: .B, .I disable hyphenation?

2021-09-12 Thread Alejandro Colomar (man-pages)
Hi Branden, On 9/12/21 7:27 PM, G. Branden Robinson wrote: Hi, Alex! At 2021-09-12T14:56:39+0200, Alejandro Colomar (man-pages) wrote: Hi Branden, Usually, when a manual page highlights a term, either in bold or italics, it usually is a special identifier (macro, function, command name or

Re: We have OSC 8 terminal hyperlink support now

2021-10-02 Thread Alejandro Colomar (man-pages)
Hi, Branden and John! On 10/2/21 4:57 PM, G. Branden Robinson wrote: Hi, John! At 2021-10-02T23:20:06+1000, John Gardner wrote: I know it's probably a bit early for this discussion, but somebody on GitHub raised a good question

Re: We have OSC 8 terminal hyperlink support now

2021-10-02 Thread Alejandro Colomar (man-pages)
Hi, Branden! On 10/2/21 7:45 PM, G. Branden Robinson wrote: Hi, Alex! At 2021-10-02T18:45:58+0200, Alejandro Colomar (man-pages) wrote: I was curious why man: and not man://, so I had a look at what uri(7) says about it. Curiously, it talks about man:. That's a good question and on

Re: We have OSC 8 terminal hyperlink support now

2021-10-06 Thread Alejandro Colomar (man-pages)
Hi, Brandem! On 10/6/21 2:53 PM, G. Branden Robinson wrote: Hi, Alex! At 2021-10-02T20:08:03+0200, Alejandro Colomar (man-pages) wrote: On 10/2/21 7:45 PM, G. Branden Robinson wrote: There is the question of what to do if a man page cross reference is ambiguous, Nothing, IMO. Even if the

Re: We have OSC 8 terminal hyperlink support now

2021-10-06 Thread Alejandro Colomar (man-pages)
On 10/6/21 3:57 PM, Alejandro Colomar (man-pages) wrote: function pdfman() { if (($# == 0)); then     >&2 echo "Usage: ${FUNCNAME[0]} [man options] [[section] page ...] ..."; Oops! Since it only supports a single page, it should be: >&2 echo &qu

Re: [PATCH] *.man: Break URIs at points specified by the Chicago Style

2021-10-18 Thread Alejandro Colomar (man-pages)
Hi, Branden! On 10/18/21 7:34 AM, G. Branden Robinson wrote: Hi, Alex! At 2021-10-17T21:33:24+0200, Alejandro Colomar wrote: Break URIs before a single slash, not after. I found no GNU-specific (or any other at all) source that recommends breaking long URIs after a slash. So follow Chicago S

Re: Two trivial questions

2021-10-26 Thread Alejandro Colomar (man-pages)
Hello Peter, On 10/26/21 11:07 PM, Peter Schaffter wrote: Second question, maybe not so trivial. Is it acceptable to use a comma for decimal fractions that are arguments to requests and macros (say .ps 12,5 instead of .ps 12.5) if a user's locale supports it? I ignore if groff technically ac

Re: SEE ALSO fails

2021-10-30 Thread Alejandro Colomar (man-pages)
On 10/30/21 19:53, Ingo Schwarze wrote: Hi James, James K. Lowden wrote on Sat, Oct 30, 2021 at 12:08:03PM -0400: A longstanding complaint of mine regarding Linux man pages is that they frequently have broken SEE ALSO references. I wonder if there's not something the groff project could do to

The 3-faces problem

2021-11-02 Thread Alejandro Colomar (man-pages)
Hey Branden! I need your wisdom :) I'm facing the 3-faces problem right now. I'm trying to write the following sentence: [ The macros [U]INTN_WIDTH expand to the width in bits of these types (N). ] With the following requisites: - N is variable, and so (I think) I want it in italics. - INT _W

Re: The 3-faces problem

2021-11-02 Thread Alejandro Colomar (man-pages)
Hi Tadziu, On 11/2/21 18:51, Tadziu Hoffmann wrote: - It's all a single identifier, so breaking it into multiple lines to avoid using \f would hurt readability. I think it's a matter of debate whether .RB [ U ] INT \fIN\fP _WIDTH or .RB [ U ] INT\c .IB N _WIDTH is more readable.

Re: The 3-faces problem

2021-11-02 Thread Alejandro Colomar (man-pages)
On 11/2/21 18:49, G. Branden Robinson wrote: Hi, Alex! At 2021-11-02T17:57:28+0100, Alejandro Colomar (man-pages) wrote: Hey Branden! I need your wisdom :) I hope to find some, someday... ;-) I'm facing the 3-faces problem right now. I'm trying to write the following senten

Re: The 3-faces problem

2021-11-02 Thread Alejandro Colomar (man-pages)
Hi, Branded! On 11/2/21 19:45, G. Branden Robinson wrote: Hi, Alex! At 2021-11-02T19:07:05+0100, Alejandro Colomar (man-pages) wrote: On 11/2/21 18:49, G. Branden Robinson wrote: printf '_\\fB_\\fI_\\f(BI_\n' | nroff | cat -s Yes, I see 4 different glyphs. Okay, so that much

Re: [BUG] -T html: \- rendered as something different than ASCII 45

2022-01-24 Thread Alejandro Colomar (man-pages)
Hi Branden, (D'oh! I used the wrong email address for all of these mails :-/) On 1/24/22 22:13, Alejandro Colomar wrote: > Hi Branden, > > And another html bug; however, this one seems to be a browser bug, but > please confirm. > > For the following code: > > [ > .TP > .B \(aq\-\(aq > Empty wh

Re: [BUG] -T html: .RS/.RE incorrectly indented

2022-01-25 Thread Alejandro Colomar (man-pages)
On 1/25/22 01:29, G. Branden Robinson wrote: Hi, Alex! At 2022-01-24T21:48:51+0100, Alejandro Colomar wrote: I wrote a filter chess game a few days ago, and wrote some manual pages for it. When I decided to serve the manual pages online on my website, I found a few bugs, that I guess are gr

Re: [BUG] -T html: \- rendered as something different than ASCII 45

2022-01-25 Thread Alejandro Colomar (man-pages)
Hi Branden, On 1/25/22 01:58, G. Branden Robinson wrote: Hi Alex, At 2022-01-24T22:13:32+0100, Alejandro Colomar wrote: Hi Branden, And another html bug; however, this one seems to be a browser bug, but please confirm. Maybe not. For the following code: [ .TP .B \(aq\-\(aq Empty white ce

Re: [BUG] .MR: hyperlink only on html, but not on pdf or terminal

2022-01-25 Thread Alejandro Colomar (man-pages)
Hi Branden, On 1/25/22 02:09, G. Branden Robinson wrote: [...] > Also, from groff_man(7): >Hyperlink macros >Man page cross references are best presented with .MR. Email >addresses are bracketed with .MT/.ME and other forms of hyperlink >with .UR/.UE. Hyperlinked text

Re: groff_man_style(7): wfix needed

2022-01-25 Thread Alejandro Colomar (man-pages)
Hi Branden, On 1/25/22 03:12, G. Branden Robinson wrote: > Hi, Alex! > > At 2022-01-24T23:07:52+0100, Alejandro Colomar wrote: >> Hi, Branden! >> >> My brain returned EAMBIGUOUS for the following paragraph: >> >> [ >>\(aq Basic Latin apostrophe. Some output devices re‐ >>

Re: [Wishlist] .MT/.ME: The mailto link doesn't contain the name

2022-01-25 Thread Alejandro Colomar (man-pages)
Hi Branden, On 1/25/22 17:12, G. Branden Robinson wrote: > Hi, Alex, > > Quite bizarrely, I did not get this message in my inbox, nor even in my > spam folder. Thanks, GMail! :-| > > At 2022-01-24T22:32:13+0100, Alejandro Colomar wrote: >> Some wish. For the following code: >> >> [ >> .MT alx

Re: [Wishlist] Don't discard groff comments on HTML output

2022-01-27 Thread Alejandro Colomar (man-pages)
Hello T. Kurt, On 1/27/22 16:18, T. Kurt Bond wrote: > And troff comments appearing in html output as html comments is > something I explicitly DON’T want happening.  My comments are NOT > intended to be part of the finished document in any form. Sounds perfecty reasonable. So, if this is added,

Re: preview of man(7) navigation/hyperlink features in groff 1.23

2022-01-27 Thread Alejandro Colomar (man-pages)
Hi Branden, On 1/26/22 22:05, G. Branden Robinson wrote: Hi everybody, I don't normally stump for this sort of thing but I'm pleased with several of the new features we've got coming for a better man page browsing experience in groff 1.23 and I thought I would share them. Long story short, we

CHECKSTYLE: Report problems with a non-zero status

2022-01-30 Thread Alejandro Colomar (man-pages)
Hi Branden, I started using groff(1)'s -rCHECKPATCH=3 in my chessutils game suite (consisting of exactly 1 game right now :~). See As with C static analyzers, I added it to the

CHECKSTYLE: Report consecutive .?P (paragraph macros)

2022-01-30 Thread Alejandro Colomar (man-pages)
Hi Branden, Recently you reported to me a style error: [ .PP .TP tag paragraph ] In general, consecutive paragraph marcos are wrong, right? .IP, .PP, .TP (and I may forget some more). I've tried it with -rCHECKSTYLE=3 and I got nothing. I think this one should be easy to implement, and would

Re: CHECKSTYLE: Report problems with a non-zero status

2022-02-01 Thread Alejandro Colomar (man-pages)
Hi Branden, On 2/1/22 20:34, G. Branden Robinson wrote: > I have a recommendation or two for how you should be able to get the > behavior you want. > > Quoting your commit diff above... > > +DEFAULT_GROFFFLAGS := -man > +DEFAULT_GROFFFLAGS += -rCHECKSTYLE=3 > +DEFAULT_GROFFFLAGS += -z > +EXTRA_G

Re: CHECKSTYLE: Report consecutive .?P (paragraph macros)

2022-02-01 Thread Alejandro Colomar (man-pages)
Hi Branden, On 2/1/22 21:22, G. Branden Robinson wrote: > I digress, but because I can already hear fundamentalists sweatily > reaching for their Bibles, I'll append some links to heretical > literature. > > > https://web.archive.org/web/20201001070605/https://symas.com/the-sad-s

Re: CHECKSTYLE: Report problems with a non-zero status

2022-02-01 Thread Alejandro Colomar (man-pages)
Hi Branden, On 2/1/22 20:34, G. Branden Robinson wrote: > That's a reasonable thing to want but it runs against the grain of how > *roff programs generally handle diagnostics and exit statuses. > > I have a recommendation or two for how you should be able to get the > behavior you want. Thanks!

Re: CHECKSTYLE: Report consecutive .?P (paragraph macros)

2022-02-01 Thread Alejandro Colomar (man-pages)
Hi Bjarni, On 2/2/22 01:32, Bjarni Ingi Gislason wrote: > A usable tool is "mandoc -T lint". Irrelevant output is just weeded > out with a filter. I like that one too. It catches .IP followed by .PP. I'll add it; I'll use both tools. And for man-pages(7) too. I'll CC you both when I add it

mandoc warning: line scope broken: RE breaks TP (was Re: CHECKSTYLE: Report consecutive .?P (paragraph macros))

2022-02-01 Thread Alejandro Colomar (man-pages)
Hi Branden, Bjarni, On 2/2/22 01:32, Bjarni Ingi Gislason wrote: > On Mon, Jan 31, 2022 at 12:52:41AM +0100, Alejandro Colomar (man-pages) wrote: >> Hi Branden, >> >> Recently you reported to me a style error: >> >> [ >> .PP >> .TP >> tag >&g

mandoc warning: line scope broken: RE breaks TP (was Re: CHECKSTYLE: Report consecutive .?P (paragraph macros))

2022-02-04 Thread Alejandro Colomar (man-pages)
CC += mandoc On 2/2/22 03:19, Alejandro Colomar (man-pages) wrote: > Hi Branden, Bjarni, > > On 2/2/22 01:32, Bjarni Ingi Gislason wrote: >> On Mon, Jan 31, 2022 at 12:52:41AM +0100, Alejandro Colomar (man-pages) >> wrote: >>> Hi Branden, >>> >&g

style: .MR

2022-02-07 Thread Alejandro Colomar (man-pages)
Hi Branden, How would you use .MR on non-man[23] (e.g., man1) pages to refer to the same topic of the manual page? I mean, how would you refer to groff(1) from within groff.1? .MR groff .MR groff 1 ? If you omit the number, you get empty parentheses, which for man[23] pages looks good (they ar

[BUG] Hyperlink macros: breaking should conserve the full hyperlink

2022-02-07 Thread Alejandro Colomar (man-pages)
Hi Branden, I realized that when you break a hyperlink, the terminal shows an incorrect link. For the following code: [ See: .UR https://www.kernel.org/\:doc/\:html/\:latest/\:process/\:coding-style.html\:#allocating-memory .UE ] I see the following output: [ See: ⟨https:/

groff_man_style.7: Hyperlink macros: \: before or after '#', '?'?

2022-02-07 Thread Alejandro Colomar (man-pages)
Hi Branden, I see that groff_man_style(7) gives advice on where to break URIs regarding slashes and dots, but not '?' and '#', which are other common symbols on URIs. I see that groff(1) seems to break before, in your manual pages, so I'll follow that practice, but maybe it's good to state it in

Ping: mandoc warning: line scope broken: RE breaks TP (was Re: CHECKSTYLE: Report consecutive .?P (paragraph macros))

2022-02-07 Thread Alejandro Colomar (man-pages)
Ping On 2/2/22 03:19, Alejandro Colomar (man-pages) wrote: > Hi Branden, Bjarni, > > On 2/2/22 01:32, Bjarni Ingi Gislason wrote: >> On Mon, Jan 31, 2022 at 12:52:41AM +0100, Alejandro Colomar (man-pages) >> wrote: >>> Hi Branden, >>> >&g

Re: style: .MR

2022-02-07 Thread Alejandro Colomar (man-pages)
On 2/7/22 20:41, Humm wrote: > For functions, although perhaps looking fine, it’s semantically wrong.  > The parentheses when referring to a function approximate its parameter > or argument list.  Man page references, and thus uses of .MR, always > include a number. Tradition seems to differ:

Re: groff_man_style.7: Hyperlink macros: \: before or after '#', '?'?

2022-02-07 Thread Alejandro Colomar (man-pages)
On 2/7/22 22:35, G. Branden Robinson wrote: > Hi, Alex! > > At 2022-02-07T19:46:43+0100, Alejandro Colomar (man-pages) wrote: >> Hi Branden, >> >> I see that groff_man_style(7) gives advice on where to break URIs >> regarding slashes and dots, but not '

Re: style: .MR

2022-02-07 Thread Alejandro Colomar (man-pages)
On 2/7/22 22:28, G. Branden Robinson wrote: > It's an open question, and there is an unresolved difference of opinion > between me and Ingo Schwarze (mandoc maintainer) about a somewhat > broader issue. > > Here's the background from last August[1]. Reading all 3 messages in > the thread is recom

Re: [BUG] Hyperlink macros: breaking should conserve the full hyperlink

2022-02-07 Thread Alejandro Colomar (man-pages)
Hi Branden! On 2/7/22 22:53, G. Branden Robinson wrote: > Hi, Alex! > > At 2022-02-07T19:58:33+0100, Alejandro Colomar (man-pages) wrote: >> Hi Branden, >> >> I realized that when you break a hyperlink, the terminal shows an >> incorrect link. >> >> F

Re: [BUG] Hyperlink macros: breaking should conserve the full hyperlink

2022-02-07 Thread Alejandro Colomar (man-pages)
On 2/7/22 23:13, G. Branden Robinson wrote: > I forgot the attachment, of course. :-) > > Trying again. I see the same broken link I saw in my experiments: [ foo(1) General Commands Manual foo(1) Name foo - frobnicate a bar Description Here’s an example

Re: [BUG] Hyperlink macros: breaking should conserve the full hyperlink

2022-02-07 Thread Alejandro Colomar (man-pages)
Hi Branden, On 2/7/22 23:57, G. Branden Robinson wrote: > Hi Alex, > > At 2022-02-07T23:12:59+0100, Alejandro Colomar (man-pages) wrote: >> H, groff_man(7) isn't explicit in the need for a link text for >> .UR/.UE or .MT/.ME. > > Right. > >> Is it

Re: [BUG] Hyperlink macros: breaking should conserve the full hyperlink

2022-02-07 Thread Alejandro Colomar (man-pages)
On 2/8/22 00:13, G. Branden Robinson wrote: > $ tgu -Z -man ~/tmp/long-uri.man | grep 'x X tty' > $ tgu -man -rU1 ~/tmp/long-uri.man > foo(1) General Commands Manual foo(1) > > Name >foo - frobnicate a bar > > Description >Here’s an examp

CHECKSTYLE: warning about blank lines inside .EX/.EE

2022-02-08 Thread Alejandro Colomar (man-pages)
Hi Branden! I got a few warnings about blank lines for code inside .EX/.EE. That is typical and expected. CHECKSTYLE should not warn about those. Cheers, Alex -- Alejandro Colomar Linux man-pages comaintainer; https://www.kernel.org/doc/man-pages/ http://www.alejandro-colomar.es/

grohtml: .TP,.TQ: Unexpected blank line

2022-02-08 Thread Alejandro Colomar (man-pages)
Hi Branden, I just found a bug in grohtml(1): For the following code: [ .TP List .RS .TP .B LOONG_ITEM .TQ .B LONGISH_ITEM .TQ .B SHORT .TQ .B ANOTHER_LONG_ONE .RE ] When rendering a manual page on the terminal, I see (as expected): [ List LOONG_ITEM

Re: grohtml: .TP,.TQ: Unexpected blank line

2022-02-12 Thread Alejandro Colomar (man-pages)
Hi, Branden! On 2/12/22 08:49, G. Branden Robinson wrote: > I attempted to reproduce this with groff Git HEAD. > > $ ./build/test-groff -man -Thtml EXPERIMENTS/tag-list-in-html.man >| tag.html > free(): double free detected in tcache 2 > groff: error: troff: Aborted (core dumped) > > Suh-weet!

Re: groff_man_style(7): wfix needed

2022-02-13 Thread Alejandro Colomar (man-pages)
On 2/13/22 14:22, Dave Kemper wrote: > It appears there was no follow-up on this email list, but this issue > was fixed in commit 3733f9f5: > > http://git.savannah.gnu.org/cgit/groff.git/commit/?id=3733f9f5 Thanks, Dave and Branden :) Cheers, Alex -- Alejandro Colomar Linux man-pages comainta

Fwd: stpecpy(): A better string copy function

2022-02-13 Thread Alejandro Colomar (man-pages)
u're CCd here in the following emails in this thread. Forwarded Message Subject: stpecpy(): A better string copy function (was: CHECKSTYLE: Report consecutive .?P (paragraph macros)) Date: Sun, 13 Feb 2022 01:05:13 +0100 From: Alejandro Colomar (man-pages) To: G. Branden Robi

Fwd: Re: stpecpy(): A better string copy function

2022-02-13 Thread Alejandro Colomar (man-pages)
Forwarded Message Subject: Re: stpecpy(): A better string copy function (was: CHECKSTYLE: Report consecutive .?P (paragraph macros)) Date: Sun, 13 Feb 2022 11:40:04 +1100 From: G. Branden Robinson To: Alejandro Colomar (man-pages) Hi, Alex! At 2022-02-13T01:05:13+0100

Re: Fwd: Re: stpecpy(): A better string copy function

2022-02-13 Thread Alejandro Colomar (man-pages)
Hi, Branden and Martin! On 2/13/22 01:40, G. Branden Robinson wrote: > At 2022-02-13T01:05:13+0100, Alejandro Colomar (man-pages) wrote: >> I designed some string copying function that attempts to improve >> strecopy(), and of course the common/standard ones, including >&

Re: Fwd: Re: stpecpy(): A better string copy function

2022-02-13 Thread Alejandro Colomar (man-pages)
On 2/13/22 19:29, Alejandro Colomar (man-pages) wrote: > My opinion about that paper is that K&R C was far from perfect, and ISO > C is much more close to perfection than K&R C ever was (but I was s/I/it/ :/ > already good enough to base ISO C on it).

memccpy(3) and stpcpy(3) status in C2x (was: stpecpy(): A better string copy function)

2022-02-13 Thread Alejandro Colomar (man-pages)
Hi Branden, On 2/13/22 19:29, Alejandro Colomar (man-pages) wrote: >> Oh, I was going to ask if you were aware of stpcpy(), but if I click the >> link to codidact I see that you are. >> >> I expect/hope stpcpy to become the new norm for string copying, though >> i

Re: stpecpy(): A better string copy function (was: memccpy(3) and stpcpy(3) status in C2x)

2022-02-14 Thread Alejandro Colomar (man-pages)
On 2/14/22 21:34, Steffen Nurpmeso wrote: > I personally like my > > /*! Copy \a{src} to \a{dst}, return pointer to NUL in \a{dst}. >* Returns \NIL if \a{dst} is not large enough; \a{dst} will always be >* terminated unless \a{n} was 0 on entry. */ > EXPORT char *su_cs_pcopy_n(char

CHECKSTYLE suggestions: unnecessary quotations and unnecessary \f escape

2022-03-19 Thread Alejandro Colomar (man-pages)
Hi Branden, While fixing style issues in the man-pages project, I'm finding a few recurrent issues that I think you could warn about: Unnecessary quotations: [ .I "foo bar" .IR foo "bar" ] Unnecessary escape \f: [ foo \fIbar\fP baz ] The last one is more difficult to decide when it's unnecess

Review incorrect man-pages commit

2022-03-19 Thread Alejandro Colomar (man-pages)
Hi Branden, Michael introduced the following commit, which is incorrect (triggers a groff(1) error; see below). Do you know what is intended here? Could you please propose a fix? Thanks, Alex LINT (groff)tmp/lint/man7/glob.7.lint.groff.touch troff man7/glob.7 195 error '\`'

[BUG] groff: inconsistent behavior of " to separate arguments

2022-03-19 Thread Alejandro Colomar (man-pages)
Hi Branden, I've met some undocumented (or I couldn't find it) behavior of double quotes ("), which might be a bug in groff(1): $ cat arg.7 .TH foo 7 foo foo foo .SH Test .IR "foo"bar .IR foo"bar" .IR "foo"bar"baz" $ man ./arg.7 | cat foo(7) foofo

Re: [BUG] groff: inconsistent behavior of " to separate arguments

2022-03-20 Thread Alejandro Colomar (man-pages)
Hi Ralph, On 3/20/22 09:32, Ralph Corderoy wrote: > Hi Alex, > > - If an argument starts with a " then it ends at the next " which isn't > the start of a "" or at the end of the line if there isn't a single ". > - If an argument does not start with a " then the " within it are > literal and t

Re: [BUG] groff: inconsistent behavior of " to separate arguments

2022-03-20 Thread Alejandro Colomar (man-pages)
Hi, Branden! On 3/20/22 10:36, G. Branden Robinson wrote: > At 2022-03-20T01:29:32+0100, Alejandro Colomar (man-pages) wrote: > Ralph's description, as I parse it, is correct. I'll speak to the > broader issue of documentation coverage of the matter. > >>

Re: Review incorrect man-pages commit

2022-03-20 Thread Alejandro Colomar (man-pages)
Hi, Branden! On 3/20/22 11:52, G. Branden Robinson wrote: > > Sure! The punctuation does get a bit bewildering. > [...] Thanks for the great explanation! > > Now, for the part people actually care about, which is how to fix it: > take the escape character off of that `. > > You thus want >

Re: CHECKSTYLE suggestions: unnecessary quotations and unnecessary \f escape

2022-03-20 Thread Alejandro Colomar (man-pages)
Hi, Branden! On 3/20/22 15:07, G. Branden Robinson wrote: > Hi, Alex! > > At 2022-03-19T17:07:09+0100, Alejandro Colomar (man-pages) wrote: >> While fixing style issues in the man-pages project, >> I'm finding a few recurrent issues that I think you could warn about: &g

Re: CHECKSTYLE suggestions: unnecessary quotations and unnecessary \f escape

2022-03-20 Thread Alejandro Colomar (man-pages)
Hi Branden, On 3/20/22 18:43, G. Branden Robinson wrote: > At 2022-03-20T13:57:18+0100, Ingo Schwarze wrote: >> To summarize, i certainly wouldn't want to warn about these >> mini-issues in mandoc -T lint. Admittedly, warnings in groff accept a >> significantly higher rate of noise and false posi

Re: [BUG] groff: inconsistent behavior of " to separate arguments

2022-03-20 Thread Alejandro Colomar (man-pages)
Hi Ingo, On 3/20/22 10:48, Ingo Schwarze wrote: > Hi Alex, It seems your emails didn't reach me directly. But the email from the mailing list arrived to my other mailbox. Hummm. After that, I checked again, and I found your email in the SPAM folder... #$%* gmail! > Alejandro Colomar

Re: CHECKSTYLE suggestions: unnecessary quotations and unnecessary \f escape

2022-03-22 Thread Alejandro Colomar (man-pages)
Hi Ingo and Larry, On 3/22/22 03:44, Larry Kollar wrote: Ingo Schwarze wrote: For some reason, Ingo, I still don't get your emails. This time, not even in SPAM :(. Alejandro Colomar (man-pages) wrote on Sat, Mar 19, 2022 at 05:07:09PM +0100: While fixing style issues in the man-

Re: All caps .TH page title

2022-07-22 Thread Alejandro Colomar (man-pages)
On 7/22/22 04:14, G. Branden Robinson wrote: At least, _Exit(2) and _exit(2) point to the same page. nan(3) and NAN(3) don't, though! Pretty gross. A useful counterexample of good practice, though. We can't blame the writers, since the identifiers have those names in C. Luckily, man(1)

Re: tbl(1) minor issues

2022-07-24 Thread Alejandro Colomar (man-pages)
[Sending to the list, now that I have access to a computer. I also added a bit more to it.] Hi Branden! On 7/23/22 04:50, G. Branden Robinson wrote: Thank you; I appreciate the review. Yours is the first it's gotten since I rewrote it. [ spaces, or tabs. (AT&T tbl accepted only o

Re: All caps .TH page title

2022-07-24 Thread Alejandro Colomar (man-pages)
Hi Ingo, On 7/23/22 21:29, Ingo Schwarze wrote: Hi Alejandro, On 7/22/22 12:35, Alejandro Colomar (man-pages) wrote: BTW, I think I didn't reply (or if I did was very short) to your comment that other languages may find it difficult to mirror our use of subsections, since their main se

Re: manual section titles (was: All caps .TH page title)

2022-07-24 Thread Alejandro Colomar (man-pages)
On 7/23/22 21:30, G. Branden Robinson wrote: IMO system_data_types(7) bit off too much to chew. The Linux system programming interface is a collection of independently developed components, generally with loose coupling. At the risk of repeating myself, I think the data types of these compon

Re: manual section titles (was: All caps .TH page title)

2022-07-24 Thread Alejandro Colomar (man-pages)
Hi Branden, On 7/23/22 21:30, G. Branden Robinson wrote: If I were to rewrite the C library and kernel from scratch, without backwards compatibility, I'd fix many many things. But that train passed many years before I was born. Lightning will not strike in the same way again. But we are engi

Re: tbl(1) minor issues

2022-07-24 Thread Alejandro Colomar (man-pages)
Hi Dave, On 7/23/22 16:58, Dave Kemper wrote: On 7/23/22, G. Branden Robinson wrote: That's _still_ too general a claim, but it will take me some time to find a way to articulate it well. No need; we don't have to document our personal punctuation principles here. We've resolved this tbl ma

GNU extensions to Unix commands (was: All caps .TH page title)

2022-07-24 Thread Alejandro Colomar (man-pages)
Hi Ralph, On 7/23/22 12:36, Ralph Corderoy wrote: Hi Alejandro, Wandering off-topic... $ find man* -type f \ | tr '[:upper:]' '[:lower:]' \ | sort \ | uniq -d \ | while read f; do find man* -type f \ | grep -i $f; done; man2/_Exit.2 man2/_exit.2 man3/nan.3

Re: [PATCH] NULL.3def: Add documentation for NULL

2022-07-24 Thread Alejandro Colomar (man-pages)
Hi Ralph! On 7/23/22 12:23, Ralph Corderoy wrote: Hi Alejandro, As hinted in recent mails to groff@ and linux-man@, I'm going to inaugurate a new [sub]section for constants. This seems a bad idea. They're quite at home in section 3. Others disagree, with the argument that 3 is reserved fo

Re: Using tbl(1) for structure definitions

2022-07-27 Thread Alejandro Colomar (man-pages)
Hi Ralph, On 7/27/22 08:41, Ralph Corderoy wrote: Hi Alex, +.TS +l lB lB l1 lX. +\& u64 flags; /* T{ +.BR O_ * +flags */ +T} +\& u64 mode; /* T{ +Mode for +.BR O_ { CREAT , TMPFILE } +*/ +T} The inline font escapes, \fB...\fP, were much more readable because I co

Re: Using tbl(1) for structure definitions

2022-07-27 Thread Alejandro Colomar (man-pages)
HI Branden, On 7/27/22 02:12, G. Branden Robinson wrote: Hi Alex, At 2022-07-26T21:33:07+0200, Alejandro Colomar wrote: I've already read all that was relevant to me from tbl(1) regarding what I had in mind: documenting structures. Okay. Apart from those two nits I didn't get any other feed

.so colophon.man

2022-07-30 Thread Alejandro Colomar (man-pages)
Hi Branden, I'm wondering if it wouldn't be easier to have a constant '.so man-pages-colophon.man' line at the end of all of the Linux man-pages, instead of appending a COLOPHON at every release. The man-pages-colophon.man file would be shiped together with the pages, and it would be created

Re: Bug#1016412: dh-make: manpage.1.ex: Incorrect formatting for dash

2022-07-31 Thread Alejandro Colomar (man-pages)
Hi Baptiste, On 7/31/22 13:49, Baptiste Beauplat wrote: Hi Alejandro, On 2022/07/31 12:35 PM, Alejandro Colomar wrote: The template page 'manpage.1.ex' uses '-' instead of '\-' for a dash that should be a Latin minus sign (as it's in the context of command options). Using '-' would produce a

Re: .so colophon.man

2022-07-31 Thread Alejandro Colomar (man-pages)
Hi Ingo, On 7/31/22 14:20, Ingo Schwarze wrote: Hi Alejandro, Alejandro Colomar wrote on Sat, Jul 30, 2022 at 10:45:42PM +0200: I'm wondering if it wouldn't be easier to have a constant '.so man-pages-colophon.man' line at the end of all of the Linux man-pages, instead of appending a COLOPHON

Re: the compatibility of man(7) (was: man(7) .TH font change, was: groff man(7) `B` macro...)

2022-07-31 Thread Alejandro Colomar (man-pages)
On 8/1/22 00:55, Ingo Schwarze wrote: Yes, distributors that incorporate packages with man pages using the new `MR` macro, racing ahead of those same distributors' update of groff 1.23.0 (whenever that happens), run the risk of some unhappy man page readers. As i explained earlier, people do

Re: rc3: groff man pages truncated by mandoc(1)

2023-02-21 Thread Alejandro Colomar (man-pages)
Hi Branden, On Tue, Feb 21, 2023, 10:19 G. Branden Robinson < g.branden.robin...@gmail.com> wrote: > Hi Alexis, > > At 2023-02-21T19:02:14+1100, Alexis wrote: > > i've just installed rc3 via the relevant Gentoo ebuild. My Gentoo > > system is mandoc-based, via the `system-man` USE flag. > > > > R

Re: [platform-testers] groff 1.23.0.rc3 on native Windows

2023-03-12 Thread Alejandro Colomar (man-pages)
Hi Branden, On Sun, Mar 12, 2023, 18:50 G. Branden Robinson < g.branden.robin...@gmail.com> wrote: > Hi Bruno, > > I neglected to reply to your suggestions below. > > At 2023-03-06T17:53:55+0100, Bruno Haible wrote: > > > It (and intptr_t) are "optional", apparently. What do you suggest? > > > >