[Tcsh] tcsh(1) mandoc conversion completed

Kimmo Suominen kim at netbsd.org
Wed Nov 23 22:05:35 UTC 2022


Thanks, Luke. I've merged the PR. I've also deprecated the old manual
page, so tcsh.man is now the new mdoc-based version.

Cheers,
+ Kimmo

On Wed, 23 Nov 2022 at 13:56, Luke Mewburn <lukem at netbsd.org> wrote:
>
> Thanks Christos & Kimmo.
>
> I support your decision to only maintain the mdoc version
> (current tcsh.man.new) going forward.
>
> I've submitted a pull request - https://github.com/tcsh-org/tcsh/pull/59
> This contains the various editorial commits I've made.
>
> I have not made any changes to the build - I'll leave that to either of
> you to decide your preference for file (re)naming & deprecation, etc.
>
> I do have some future edits I'm considering, but they can wait until
> these changes are in.
>
>
> cheers,
> Luke.
>
>
>
> On 22-11-22 07:18, Christos Zoulas wrote:
>   | Wonderful work Luke! Thanks so much for completing it. I agree with
>   | Kim, let's go with 3. mdoc is superior to man and there is no point
>   | on keeping duplicate info around.
>   |
>   | Best,
>   |
>   | christos
>   |
>   | > On Nov 22, 2022, at 3:37 AM, Kimmo Suominen <kim at netbsd.org> wrote:
>   | >
>   | > Hi Luke,
>   | >
>   | > Thanks a lot! I would go with #3:
>   | >
>   | > - I'm not keen on maintaining two copies of the manual page (overhead!).
>   | > - Modern systems all support mdoc and it is way nicer.
>   | > - While tcsh.man2html is cool, I don't think it gets much use.
>   | > - It should be easy enough to produce HTML from mdoc (not that it is
>   | > interactive).
>   | >
>   | > Cheers,
>   | > + Kimmo
>   | >
>   | >
>   | >> On Tue, 22 Nov 2022 at 09:57, Luke Mewburn <luke at mewburn.net> wrote:
>   | >>
>   | >> Hi tcsh list,
>   | >>
>   | >> I've completed the mdoc conversion of tcsh.man.new (that Christos
>   | >> started a few years ago).
>   | >> tcsh.man.new formats nicely as text (ascii or UTF-8) as well as PS/PDF.
>   | >> I haven't tried HTML yet.
>   | >>
>   | >> I also fixed various editorial issues in tcsh.man (the currently
>   | >> installed manual in man.old format).
>   | >>
>   | >> The changes are in a branch in my github fork
>   | >>        https://github.com/lukem/tcsh/tree/lukem/man-fixes
>   | >>
>   | >> The differences between tcsh.man and tcsh.man.new are mostly
>   | >> minor editorial and formatting issues, especially where
>   | >> the mdoc format is nicer. I did convert to Oxford comma
>   | >> in tcsh.man.new and didn't backport that to tcsh.man.
>   | >>
>   | >> I compared the differences with:
>   | >>        nroff -Tascii -c -man tcsh.man | col -b > ! out.old ;
>   | >>        nroff -Tascii -c -man tcsh.man.new | col -b > ! out.new ;
>   | >>        git diff --no-index --color-words out.old out.new
>   | >>
>   | >>
>   | >> Before I submit a pull request, a question to Christos, Kimmo
>   | >> and the community:
>   | >>
>   | >> Should we continue to maintain and install both tcsh.man and tcsh.man.new ?
>   | >>
>   | >>        1. Maintain both tcsh.man and tcsh.man.new, continue to only install
>   | >>        tcsh.man by default, maintaining tcsh.man2html for the man.old.
>   | >>
>   | >>        2. Maintain both tcsh.man and tcsh.man.new, change to only install
>   | >>        tcsh.man.new, maintaining tcsh.man2html for the man.old.
>   | >>        Maybe rename tcsh.man to tcsh.man.old ?
>   | >>        Maybe rename tcsh.man.new to tcsh.man or tcsh.mandoc ?
>   | >>
>   | >>        3. Migrate to tcsh.man.new, deprecate tcsh.man and tcsh.man2html.
>   | >>        Rename tcsh.man.new to tcsh.man.
>   | >>
>   | >>
>   | >> I have some other editorial improvements and refactoring I'd like to
>   | >> do, but I'd rather wait until there's a direction for the manual page
>   | >> first.
>   | >>
>   | >>
>   | >> regards,
>   | >> Luke.
>   | >>
>   | >>
>   | >> PS: I realised it's been nearly 30 years since my first contribution to tcsh!
>   | >> Time flies.
>   | >> --
>   | >> Tcsh mailing list
>   | >> Tcsh at astron.com
>   | >> https://mailman.astron.com/mailman/listinfo/tcsh
>   | > --
>   | > Tcsh mailing list
>   | > Tcsh at astron.com
>   | > https://mailman.astron.com/mailman/listinfo/tcsh
>   |


More information about the Tcsh mailing list