6 ms·
I'm going to be frank: why? I've recently looked into making my own manpage and it's a pretty old looking system. The docs are not really clear but using some e
by lucb1e 12y ago
I'm going to be frank: why? I've recently looked into making my own manpage and it's a pretty old looking system. The docs are not really clear but using some examples and trial and error I got there. My point is though, why does it need a maintainer? The system feels old enough to get deprecated instead of keeping it alive, let alone bring out new releases.
I haven't spent more than a day working with groff though, perhaps many people still use it (every website with info just looked about as old as your average man page), so I may be completely missing the point here. If so, tell me!
- immita 12y agoWell... manpages are still very much alive and widely used, and they're so prevalent that moving to something new is a nearly ridiculous requirement. Half the things with manpages in the wild are probably themselves not maintained. Now you have two problems. We can move to something new, but getting everyone to agree on what that is, then implementing and maintaining it... isn't that more work than just maintaining the working solution everyone already agrees on, and that solves the problem?
- tomjen3 12y agoWhy not format manpages as markdown? As a consumer you wouldn't need to care about the format behind the scene and the format is already well known by programmers, there are plenty of libraries that solve can read markdown and plenty of people who know it.
- immita 12y agoI agree that might be a good choice for a more modern alternative, but it still doesn't solve the problem of existing manpages. You could cleverly upconvert on the fly of course, but that's basically the same thing as keeping groff around, except with the added friction of informing everyone that they should be using Markdown now, with new tooling and conventions. Don't underestimate the marketing costs of successfully convincing the diverse Linux ecosystems they should jump onboard. I only see this working if some big entity slams the gavel and decrees this as the new manpage standard, but I also don't see any such entity having much incentive to do so.
- fortytw2 12y agoWell, for one time only, you can convert all (make a little converter) existing groff to markdown and then stop supporting groff at all.
- vertex-four 12y agoThis works fine if you're working on a cathedral (one of the BSDs or UNIXes, for example), not so much if you're trying to work with the bazaar that is the Linux software ecosystem. What's your plan? Submit a patch for every piece of software written in the past 15 years?
- tomjen3 12y agoBut existing pages would be served with the already existing groff, right? Software doesn't rot, so the existing software will continue to work in the future.
- pfortuny 12y agoSoftware doesn't rot but libc changes...
- JoshTriplett 12y agoikiwiki's source code contains a rudimentary mdwn2man program. It doesn't handle the majority of markdown, but it works for simple pages.
- tedunangst 12y agomarkdown isn't semantic. roff macros allow one to clearly specify that function arguments (Fa) and command line flags (Fl) are different things, even if they render similarly.
- rakoo 12y agoIs this really needed in a manpage, though ? AFAIK manpages are ASCII document created with any variation of troff/nroff/groff and piped into less -s. There is no need for any semantical distinction if display is the same, since the best interaction you can have is searching for something.
- tedunangst 12y agoASCII is not the only possible output format, and yes, semantic search is useful.
- mseepgood 12y agoThese are manpages http://imgur.com/a/JZfTr http://imgur.com/a/JZfTr
- rakoo 12y agoWhile I like the venerable look they have, those books aren't what you use daily to document yourself on how your machine works. I was speaking about those manpages we use when we don't know what the letters are for in the itemized output of rsync, for instance.
- cogburnd02 12y ago> While I like the venerable look they have, those books aren't what you use daily to document yourself on how your machine works. But you can create pretty hard-copy versions of the manpages on your system with groff, the same way these books were created with troff (which groff is a replacement for.)
- jdp 12y agoAs others have noted, there is a semantic difference between Markdown and roff. But if you really want to write them in Markdown, you can with ronn: http://rtomayko.github.io/ronn/ http://rtomayko.github.io/ronn/ Ronn also supports outputting to HTML.
- lucb1e 12y agoI agree with you. Like I replied to another post: > > Replacing man pages because 'they look old' is a terribly stupid idea. > I fully agree, and it's not what I meant to say. What I meant is writing new pages in a newer language (insert random lightweight text based format, preferably one where the 'see also' part is linkable) and groff is simply deprecated and supported as well. Since there is currently support, why do we need a maintainer? That is my question.
- smutticus 12y agoReplacing man pages because 'they look old' is a terribly stupid idea. How about we replace them because there is something better? Or because they no longer fill a need? Things that are old and work are not to be messed with. Frankly, if you don't get that, I don't want you, or anyone else who thinks like you, making decisions about any UNIX I might work with. I lament the poor documentation on Linux, and OSX, and I lament the FSF's obsession with info pages. There's nothing wrong with man pages. Maybe we don't need groff to prepare them, but we need man pages.
- lucb1e 12y ago> Replacing man pages because 'they look old' is a terribly stupid idea. I fully agree, and it's not what I meant to say. What I meant is writing new pages in a newer language (insert random lightweight text based format, preferably one where the 'see also' part is linkable) and groff is simply deprecated and supported as well. Since there is currently support, why do we need a maintainer? That is my question. > Things that are old and work are not to be messed with. Agreed, so what's the maintainer going to do? > Maybe we don't need groff to prepare them, but we need man pages. Once again, I agree. Sorry if I sounded like man pages are unnecessary, that is not what I meant.
- anjbe 12y ago> What I meant is writing new pages in a newer language (insert random lightweight text based format, preferably one where the 'see also' part is linkable) A little bit of manpage history: Roff has been around since the beginning of Unix (in fact, the group at Bell Labs who developed Unix got funding by convincing managers they could come up with a good typesetting system). Roff supports a variety of macro sets; for a long time, the most common one for manpages was the “man” macros. In the early 1990s, BSD came up with the “mdoc” macros, which are a significant improvement over the original “man” macros. mdoc is inherently semantic, and allows easy searching and conversion to other formats, including HTML. You can search for based based on function return type or argument type, program authors, include files and environment variables used, and many more. mdoc pages natively support hyperlinking, including links to other manpages, links within the same manpage, and external hyperlinks. Mdoc is a very pleasant language, and since it’s used in roff you can combine it with other macro sets like tbl (for tables) and eqn (for mathematics). It supports UTF‐8, it can easily be converted to PDF and/or semantic HTML, and provides great searchability. It’s well‐documented and widely supported (mdoc pages are supported out of the box on any system using mandoc or groff for manpages, meaning Linux, OpenBSD, FreeBSD, NetBSD, Mac OS X, Illumos, Minix…).
- pflanze 12y agoPerhaps you'll be interested in this discussion of markup format and tool chain alternatives to GNU info (in the context of Emacs): http://lwn.net/Articles/625072/ http://lwn.net/Articles/625072/ (It got no interest on HN: https://news.ycombinator.com/item?id=8911625 https://news.ycombinator.com/item?id=8911625)