Slashdot Mirror


Man Page Project Can Now Use Official POSIX Docs

Martin_Sturm writes "The IEEE consortium announces in a recent press release that it granted permission to the Linux Man Page Project to incorporate material from the official documentation on the POSIX standard. Obviously this is very good news for the Man Page project which now has access to a huge amount of good documentation. Until recently the project could not use this documentation due to copyright restricions."

53 of 229 comments (clear)

  1. yay! by Ozone+Depletion · · Score: 2, Funny

    I love my man! 3

    1. Re:yay! by Paleomacus · · Score: 2, Funny

      man bind,man kill,man bash, man touch, and man finger are my favorites

  2. bah! by monkey_jam · · Score: 3, Funny

    real *nix users dont need man pages!

    1. Re:bah! by Richard_at_work · · Score: 2

      Nope, GNU seems to think they need info pages more tho :(

    2. Re:bah! by bersl2 · · Score: 4, Insightful

      Seriously, besides GNU, who else favors info over man? I find the system difficult to navigate. For instance, when I was first learning {,ba}sh... damn, the bash info page sucks.

    3. Re:bah! by JoeBuck · · Score: 5, Informative

      The format is not info but texinfo, which produces output in many forms: TeX (for typeset documents), HTML, as well as info; furthermore, the man pages for many GNU programs are now produced by automatic conversion from the info source.

      Texinfo beats roff format for man pages because it supports structure and hyperlinks. XML (or SGML) formats are even better, but "man format" sucks. And I've written a lot of "man pages" in my career.

    4. Re:bah! by mullein · · Score: 2, Informative
      Seriously, besides GNU, who else favors info over man? I find the system difficult to navigate. For instance, when I was first learning {,ba}sh... damn, the bash info page sucks.

      I always hated using info pages until I came across pinfo, a colorized info/man viewer using arrow keys. That phrase is insufficient to describe its utility. It actually makes info pages useful! Debian has it in package repositories and I'd guess that other Linux distributions, perhaps BSDs, etc. package it.

  3. Man pages are evil... by inertia187 · · Score: 4, Funny
    It's evil because there's a deamon involved, and this command:
    $ man mount
    --
    A programmer is a machine for converting coffee into code.
    1. Re:Man pages are evil... by Anonymous Coward · · Score: 3, Funny

      maybe you need to try these command first ...

      man date

      man strip

      i'd leave the dollar sign out that's illegal
      in most states.

    2. Re:Man pages are evil... by Anonymous Coward · · Score: 5, Funny
      Check out the complete output:
      $ man woman
      No manual entry for woman
      How appropriate.
    3. Re:Man pages are evil... by PowerPill · · Score: 2, Funny

      Yes and if you: $ man pump too many times you could go blind.

    4. Re:Man pages are evil... by Feztaa · · Score: 3, Funny
      Yeah, but once you learn out how to mount, you can:
      $ mount /woman
    5. Re:Man pages are evil... by jrockway · · Score: 3, Interesting

      Try M-x woman in emacs.

      --
      My other car is first.
  4. A play on "The Grumpy Man" from SNL by DarkHelmet · · Score: 3, Funny
    Real Linux hackers do not use man! They look at the source and figure out how the program works from the command line!

    And back before we had all this open-schopen source, we had to decompile our programs so that we could figure out how it works.

    And before we had fancy-shmancy C/C++, we disassembled our programs and found out how they worked from there.

    And we liked it!

    --
    /^[A-Z0-9._%+-]+@[A-Z0-9.-]+\.[A-Z]{2,4}$/i
    1. Re:A play on "The Grumpy Man" from SNL by Anonymous Coward · · Score: 5, Funny

      Shhh ! You're gonna wake up one of these 3 digits slashdot ID elders. And you know how they love to speak about good ol'time...

    2. Re:A play on "The Grumpy Man" from SNL by Surazal · · Score: 2, Funny

      You know, back in *my* day, we didn't have these fancy-schmancy SCSI cables to help us write our data to disk. No, in my day, we had to write it down using burnt sticks we pulled from smoldering camp fires. Then we ran across the savana, burnt stick and all. And when we got to our destination to write that data to disk, when we got an error, we had to run all the way back to our camp and yell out at the top of our lungs "WRITE ERROR! CHECK CONDITION!" Then we had to run all the way back just to get the sense key data.

      Beat *that*!

      --
      --- Journals are boring; Go to my web page instead
    3. Re:A play on "The Grumpy Man" from SNL by mce · · Score: 3, Funny

      You already had disks to run to and write on? Jeez, I guess it shows that my 3-digit slashdot ID is considerably lower than yours. :-) Back when I started, we had to use our brain. That good ol'technology did save us a lot of useless running, though...

    4. Re:A play on "The Grumpy Man" from SNL by Russ+Steffen · · Score: 5, Funny

      Ach, you kids and your "brains." When I started we had to do all our thinkin' with just a few neurons at the top of our spinal chords. And we liked it! We loved it!

      Brains? Luxury...

    5. Re:A play on "The Grumpy Man" from SNL by Surazal · · Score: 2

      Spinal cords!?

      Ok, you know, there are some jokes that never get old. Others were born that way. Back in my day, all the jokes were old! Why, some of our jokes were so old that we would just we wouldn't have to tell the whole joke for it

      --
      --- Journals are boring; Go to my web page instead
    6. Re:A play on "The Grumpy Man" from SNL by zoeblade · · Score: 2, Informative

      Saturday Night Live? If that sketch is what it sounds like, it was pre-Python. I forget who performed it originally (At Last, the 1948 show?), but it had some of the Python members in it, if I recall correctly.

  5. Who cares about the IEEE? by Anonymous Coward · · Score: 4, Funny

    Do they have SCO's permission?

  6. However... by SnowZero · · Score: 4, Funny

    In return for the free content, all man pages will be required to incorporate ascii-art banner ads.

    1. Re:However... by plams · · Score: 3, Funny

      would the ads be context sensitive? you know, adapt themselves to the user's preferences?

      > man mount

      * Do you realise that 10% of all males *
      * are GAY? * * * * K-Y-Jelly in K-mart *
      * * * * only $9.95!!!1!! * * * * * * * *

      NAME

      mount - mount a file system

      SYNOPSIS

      mount [-lhV]

      mount -a [-fFnrsvw] [-t vfstype] [-O optlist]
      mount [-fnrsvw] [-o options [,...]] device | dir
      mount [-fnrsvw] [-t vfstype] [-o options] device dir
      etc..

  7. man, that's cool! by adrianbaugh · · Score: 4, Insightful

    (Ahem.) I like man chiefly because the default (command-line) browser program doesn't suck quite so much. I'm sure there are technically superior ways to store documentation, but man is very readable. info, on the other hand, blows.

    --
    "'I pass the test,' she said. 'I will diminish, and go into the West, and remain Galadriel.'"
    - JRR Tolkien.
    1. Re:man, that's cool! by Anonymous Coward · · Score: 5, Informative

      Try reading info pages with "pinfo" instead of "info" - you'll like info pages much more when you've got a decent viewer =)

    2. Re:man, that's cool! by GammaTau · · Score: 2, Interesting

      Try reading info pages with "pinfo" instead of "info" - you'll like info pages much more when you've got a decent viewer =)

      Yeah, pinfo is definitely better than the default info viewer. The only problem with pinfo is that it's not really standard. If I log on to a system I'm not familiar with (and then I often really _need_ documentation), I can't be sure if "pinfo foo" will work whereas "man foo" will work with almost 100% certainity.

      Because it is pretty much guaranteed that man pages can be read on every system without any viewer brain damage, it also leads to a situation where many people write only man pages and additional documentation in other formats (like plain text or HTML). I know that info can view man pages when info pages are not found but I rarely bother. I just use "man foo" and if that doesn't give what I'm searching for, then check /usr/share/doc or search the web.

  8. Typical GNU utility man page... by compass46 · · Score: 4, Funny

    $ man cp

    "The UNIX man page system sucks. Use the info system instead."

    so...

    $ info cp

    "The UNIX man page system sucks. Use the info system instead."

    1. Re:Typical GNU utility man page... by petabyte · · Score: 4, Informative

      Umm, both my slackware and gentoo boxes have a full man page for cp. Apparently they're from the fileutils package.

      I'd suggest everyone load up the funny-manpages and asr-manpages if you're bored.

      man lart

  9. No more see info? by zsau · · Score: 4, Interesting

    Does this mean no more cruel messages telling us to see the info pages?

    --
    Look out!
  10. If one more.. by Anonymous Coward · · Score: 2, Funny

    If one more Slashbot makes a "DO U HAVE SCO'S PERMISSION? LOL" reference, I will touch your junk liberally.

  11. How useful is this? by A+nonymous+Coward · · Score: 4, Interesting

    Most man pages have long since been written from scratch for Linux. It would seem that any man pages still missing must be pretty rarely used, or for obsolete commands.

    There are differences between UNIXes and Linux distributions and BSD distributions. What do the POSIX man pages document, and is it more trouble than it is worth to use them as a basis for Linux man pages?

    I really don't know, this is not a troll, I didn't even know that there were POSIX man pages.

    1. Re:How useful is this? by dietz · · Score: 4, Informative

      I really don't know, this is not a troll, I didn't even know that there were POSIX man pages.

      There are no POSIX man pages. But previously they weren't allowed to even quote the POSIX standard in their manpages. They had to rewrite it all and hope they didn't introduce any inaccuracies in their rewriting.

      Now they can just quote the standard itself where they want to.

      This is mostly important for programming documentation (e.g. "man 3 strerror")

    2. Re:How useful is this? by matusa · · Score: 2, Informative

      It's extremely useful for things like 'this glibc function deviates slightly from POSIX section xx.yy, which states:'

      Another good one is 'This extension[/odd syntax/whatever] is for compliance which POSIX section aa.bb, which states as follows:'

      (purposeful inconsistency.. boredom otherwise)

  12. Yeah, but... by inertia187 · · Score: 5, Funny
    They still need to improve the hideous grammar of the man pages:
    $ man nothing
    No manual entry for nothing
    --
    A programmer is a machine for converting coffee into code.
  13. Has anyone here tried to write man pages? by Pyromage · · Score: 5, Interesting

    I see a lot of people bitching about how info sucks. Well, you know what? Maybe it does. But have you actually tried to write a man page?

    The syntax for roff just sucks. Info, on the other hand, is a fairly reasonable way to write documentation.

    1. Re:Has anyone here tried to write man pages? by belmolis · · Score: 2

      I hate to tell you this, but those of us who predate TeX used *roff to write all sorts of things, including my dissertation. Writing elaborate man pages (e.g. with tables) is probably painful for anyone who doesn't already know *roff well, but most man pages require only a handful of macros and no understanding of how to write them or any of the other fine points.

  14. wtf? This wasn't automatic? by visualight · · Score: 4, Interesting

    The most interesting point of this story is that the entire planet wasn't given permission to reprint the posix standard from day one. It's a standard isn't it?

    Isn't promoting standards one of the main reasons for the IEEE consortium's existance? How do you promote standards by not allowing anyone to reprint them?

    And the Linux Man Page Project expresses how grateful they feel. Whatever.

    --
    Samsung took back my unlocked bootloader because Google wants me to rent movies. They're both evil.
    1. Re:wtf? This wasn't automatic? by vidarh · · Score: 4, Informative

      Many standards organisations survive to a large extent on income generated by selling copies of the standards documents. It's only in recent years started becoming common for standards documents to be available free. Still, even now most ANSI and ISO standards for instance still costs money.

    2. Re:wtf? This wasn't automatic? by CRCulver · · Score: 2, Interesting

      Standards, when published in print, are often sold for a heck of a lot of money. Take for instance the Unicode standard. It's an open standard, and quite important for internationalisation in our digital age, but you'll pay $74 to get it. When Linus was developing Linux, he had to get his POSIX information through Minix because it was too expensive to go right to POSIX.

  15. Good, by noselasd · · Score: 2

    Does that mean well get some docs on the pthreads rwlocks and posix semaphores ? Just yesterday I needed them, and sadly discovered they were missing ,(

  16. Could this mean... by rhythmx · · Score: 2, Informative
    the beginnings of Linux-3.0.0??? from Linux kernel readme:
    WHAT IS LINUX? Linux is a Unix clone written from scratch by Linus Torvalds with assistance from a loosely-knit team of hackers across the Net. It aims towards POSIX compliance.
    The next major version will be released when the new kernel will break support for almost all existing binaries. If all the kernel interfaces are tweaked and made to be posix compliant. We may be seeing the Linux-3.0.0 soon!
  17. Re:GNU info sucks. by adrianbaugh · · Score: 2, Funny

    While GNU's perfectly within its rights to call their own creation GNU/info they were getting laughed at too much when they tried to insist on GNU/HTML :-)

    --
    "'I pass the test,' she said. 'I will diminish, and go into the West, and remain Galadriel.'"
    - JRR Tolkien.
  18. Use POD and pod2man by barries · · Score: 2, Informative
    Yeah, it's trival: use POD. And pod2man. Or any other format you want (po2html, pod2text, etc) on almost any system with Perl on it. And integrate it in to your program as online help. And usage. And and and...

    Use the right tool, don't let the wrong tool use you.

    - Barrie

  19. Re:Man & Info by AJWM · · Score: 5, Informative

    How would the 650 page GCC manual look as a man page?

    Like it was done by someone who didn't understand the Unix documentation scheme.

    The man pages were never the entire body of Unix documentation, just the first volume. The second volume consisted of longer, more tutorial or in depth documents for the programs that needed it. (Like some compilers, or awk, or [t]roff, etc.)

    Way back in prehistory I worked with a port of Version 7 Unix (UTS) that came with a complete set of printed manuals -- the man pages were only half the documentation.

    That said, info is lame, and commands that have no man page because they have info doubly so.

    --
    -- Alastair
  20. Examples..... by nighty5 · · Score: 2, Insightful

    I find the lack of examples in man pages to be a real pain....Example take a look at the crontab manual, it would be nice to see how to formulate an example to place into the crontabs. You'll find such things in Solaris.

    1. Re:Examples..... by Shadowlore · · Score: 2, Informative
      Insightful?!?!?! It's dead wrong!

      I teach System Admin. Had a class this week in fact. Used the man page on crontab to do it, and it included examples right there in the manpage.


      EXAMPLE CRON FILE
      # use /bin/sh to run commands, no matter what /etc/passwd says
      SHELL=/bin/sh
      # mail any output to `paul', no matter whose crontab this is
      MAILTO=paul
      #
      # run five minutes after midnight, every day
      5 0 * * * $HOME/bin/daily.job >> $HOME/tmp/out 2>&1
      # run at 2:15pm on the first of every month -- output mailed to paul
      15 14 1 * * $HOME/bin/monthly
      # run at 10 pm on weekdays, annoy Joe
      0 22 * * 1-5 mail -s "It's 10pm" joe%Joe,%%Where are your kids?%
      23 0-23/2 * * * echo "run 23 minutes after midn, 2am, 4am ..., everyday"
      5 4 * * sun echo "run at 5 after 4 every sunday"


      That is taken from the man page for crontab, section 5, from RH9/Fedora. I also contains a detailed description of each field.
      --
      My Suburban burns less gasoline than your Prius.
  21. XSLT to generate man pages by KidSock · · Score: 4, Interesting

    The syntax for roff just sucks.

    Try using XSLT to generate troff. The CStyleX package will let you generate concise troff macros for GNU style C programming interface man pages (just like the screenshot on this page):

    http://www.ioplex.com/~miallen/cstylex/

    Actually the best part is that this will also generate HTML from the same source XML. And nothing prevents you from generting PostScript in the future or just about anything else for that matter. IOW you write XML run make and get man pages and HTML.

    PS: The package hasn't been updated in a while. The latest man.xsl and ref.xsl transforms are in the libmba package cited on the page referenced.

    1. Re:XSLT to generate man pages by lewp · · Score: 2, Insightful

      XSLT? He wants easier, not harder. That's probably the one thing I wouldn't recommend he try.

      --
      Game... blouses.
  22. POSIX standard onlin by fredex · · Score: 2, Interesting
    The article says:
    Another was the recent decision to make the POSIX standard freely available on the Internet.
    but where are they "freely" available? I've just scored both ieee and open group websites and the best I can find is some PDF documents at prices beginning around $105 and going up. Not what I call freely available.
    1. Re:POSIX standard onlin by Anonymous Coward · · Score: 2, Informative

      Download POSIX 2001.

      (POSIX 2001 and SUSv3 are the same document.)

  23. Grumpy middle-aged man wakes up by JoeBuck · · Score: 4, Interesting

    Sorry, four digits. But then, I did use the Arpanet before the Jan 1982 switchover to TCP/IP, so I am damn old.

    Today's man pages look almost the same as 1981 man pages from Bell Labs, so you haven't missed much by being young.

  24. Release Notes (man-pages-1.65.Announce) by An+Anonymous+Hero · · Score: 4, Informative

    (Since this is not very informative:)
    RELEASE
    The Linux man page maintainer proudly announces. . .

    man-pages-1.65.tar.gz - man pages for Linux

    POSIX
    This release is the first to contain the POSIX 1003.1-2003 man pages. The directories man0p, man1p, man3p contain descriptions of the headers, the utilities, and the functions documented in that standard.

    Permission to distribute these POSIX man pages has just been obtained, and the pages in man0p, man1p, man3p were derived from the POSIX html pages by some silly conversion script. No doubt the result is still full of flaws, and all of this can be much improved. Corrections, scripts, etc. are welcome - aeb@<snip>.

    In order to use this, put in {/usr/share/misc/}man.conf{ig} or so your favourite order of looking at these pages, for example,
    MANSECT 1p:1:8:0p:3p:2:3:4:5:6:7:9:tcl:n:l:p:o
    or set the MANSECT environment variable.

    OTHER PAGES
    The remaining pages are most of the section 2, 3, 4, 5, 7 man pages for Linux, and in addition section 1 man pages for the fileutils-4.0 utilities, and section 5 and 8 man pages for the timezone utilities.

    [The latter were taken from ftp://elsie.nci.nih.gov/pub/tzcode2001a.tar.gz.] [The section 3 man pages for the db routines have been taken from ftp://ftp.terra.net/pub/sleepycat/db.1.86.tar.gz.] [The rpc man pages were taken from the 4.4BSD-Lite CDROM.]

    Differences from version 1.64:

    POSIX pages were added

    The man pages

    chroot.2 clone.2 intro.2 mkdir.2 remap_file_pages.2

    errno.3

    sk98lin.4

    elf.5 protocols.5 raw.7

    are new or have been updated. Typographical or grammatical errors have been corrected in several other places.

    Here is a breakdown of what this distribution contains:

    Section 0p = POSIX headers
    Section 1p = POSIX utilities
    Section 3p = POSIX functions

    Section 1 = user commands (intro, and pages not maintained by FSF)
    Section 2 = system calls
    Section 3 = libc calls
    Section 4 = devices (e.g., hd, sd)
    Section 5 = file formats and protocols (e.g., wtmp, /etc/passwd, nfs)
    Section 6 = games (intro only)
    Section 7 = conventions, macro packages, etc.
    Section 8 = system administration (intro only)

    Usually, there are no section 1, 6 and 8 man pages because these should be distributed with the binaries they are written for. Sometimes Section 9 is used for man pages describing parts of the kernel.

    Note that only Section 2 is rather complete, but Section 3 contains several hundred man pages. If you want to write some man pages, please do so and mail them to aeb@<snip>.

    The following people (listed in alphabetical order by first name) wrote, edited, or otherwise contributed to this project:

    <snip>

    Copyright information:

    For the POSIX pages permission to distribute was given by IEEE and the Open Group, see POSIX-COPYRIGHT.

    For the remaining pages, please note that these man pages are distributed under a variety of copyright licenses. Although these licenses permit free distribution of the nroff sources contained in this package, commercial distribution may impose other requirements (e.g., acknowledgement of copyright or inclusion of the raw nroff sources with the commercial distribution).
    If you distribute these man pages commercially, it is your responsibility to figure out your obligations. (For many man pages, these obligations require you to distribute nroff sources with any pre-formatted man pages that you provide.) Each file that contains nroff source for a man page also contains the author(s) name, email address, and copyright notice.
  25. Re: Why info? by some+guy+I+know · · Score: 2, Informative
    Can someone tell me the point of info? [...] Why not just HTML and your favorite browser?
    The info format was created a long time ago.
    At that time, HTML didn't yet exist (or, at least, wasn't ubiquitous as it is now), so info made at least some sense (although I've always preferred man pages and n/troff docs myself).
    Nowadays, however, it makes no sense at all to continue with info when HTML/XML is so common.
    All of the info docs should be translated to HTML or XML and the old, obsolete info format should be abandoned.
    --
    Those who sacrifice security to condemn liberty deserve to repeat history or something. - Benjamin Santayana