<?xml version="1.0" encoding="UTF-8"?><rss version="2.0"
	xmlns:content="http://purl.org/rss/1.0/modules/content/"
	xmlns:dc="http://purl.org/dc/elements/1.1/"
	xmlns:atom="http://www.w3.org/2005/Atom"
	xmlns:sy="http://purl.org/rss/1.0/modules/syndication/"
		>
<channel>
	<title>Comments on: Manpages</title>
	<atom:link href="http://www.sharms.org/blog/2009/09/manpages/feed/" rel="self" type="application/rss+xml" />
	<link>http://www.sharms.org/blog/2009/09/manpages/</link>
	<description>Life, Linux and Technology</description>
	<lastBuildDate>Thu, 26 Jan 2012 02:40:20 +0000</lastBuildDate>
	<sy:updatePeriod>hourly</sy:updatePeriod>
	<sy:updateFrequency>1</sy:updateFrequency>
	<generator>http://wordpress.org/?v=3.3.1</generator>
	<item>
		<title>By: UX-admin</title>
		<link>http://www.sharms.org/blog/2009/09/manpages/comment-page-1/#comment-1379</link>
		<dc:creator>UX-admin</dc:creator>
		<pubDate>Sun, 29 Nov 2009 04:02:10 +0000</pubDate>
		<guid isPermaLink="false">http://www.sharms.org/blog/?p=588#comment-1379</guid>
		<description>It appears that you misunderstand what manual pages are.

They&#039;re written a so-called &quot;minilanguage&quot;, or rather, several minilanguages, yes, PROGRAMMING LANGUAGES, which facilitate TYPSETTING, NOT FORMATTING.

Typesetting, as in, preparing and formatting a book for print!

Displaying formatted ASCII text with the man(1) command just happens to be a sideeffect of how flexible and powerful the tbl(1), eqn(1) and troff(1) tools are.

A typical book-for-print preparation might look like:

eqn file &#124; tbl &#124; troff -Tps &gt; ready-to-print-file.ps

While a manual page formatting might look like

tbl command.tbl &gt; /opt/abcd/share/man/command.1

Your statement that &quot;man pages live in their own little world&quot; is indicative of your misunderstanding of the capabilities of the said tools and intent; I suggest you educate yourself on the subject before you go off on a tangent with HTML and CSS and XML/XSLT and RST next time.

A good start is a book called &quot;UNIX text processing&quot; written by Dale Dougherty and Tim O&#039;Reilly of the O&#039;Reilly fame.

No excuses in the form of &quot;I don&#039;t have enough time&quot; will be recognized as valid; after all, you had the time to scribble all this, TIME YOU COULD HAVE SPENT LEARNING TROFF.</description>
		<content:encoded><![CDATA[<p>It appears that you misunderstand what manual pages are.</p>
<p>They&#8217;re written a so-called &#8220;minilanguage&#8221;, or rather, several minilanguages, yes, PROGRAMMING LANGUAGES, which facilitate TYPSETTING, NOT FORMATTING.</p>
<p>Typesetting, as in, preparing and formatting a book for print!</p>
<p>Displaying formatted ASCII text with the man(1) command just happens to be a sideeffect of how flexible and powerful the tbl(1), eqn(1) and troff(1) tools are.</p>
<p>A typical book-for-print preparation might look like:</p>
<p>eqn file | tbl | troff -Tps &gt; ready-to-print-file.ps</p>
<p>While a manual page formatting might look like</p>
<p>tbl command.tbl &gt; /opt/abcd/share/man/command.1</p>
<p>Your statement that &#8220;man pages live in their own little world&#8221; is indicative of your misunderstanding of the capabilities of the said tools and intent; I suggest you educate yourself on the subject before you go off on a tangent with HTML and CSS and XML/XSLT and RST next time.</p>
<p>A good start is a book called &#8220;UNIX text processing&#8221; written by Dale Dougherty and Tim O&#8217;Reilly of the O&#8217;Reilly fame.</p>
<p>No excuses in the form of &#8220;I don&#8217;t have enough time&#8221; will be recognized as valid; after all, you had the time to scribble all this, TIME YOU COULD HAVE SPENT LEARNING TROFF.</p>
]]></content:encoded>
	</item>
	<item>
		<title>By: ulrik</title>
		<link>http://www.sharms.org/blog/2009/09/manpages/comment-page-1/#comment-1378</link>
		<dc:creator>ulrik</dc:creator>
		<pubDate>Tue, 22 Sep 2009 20:10:22 +0000</pubDate>
		<guid isPermaLink="false">http://www.sharms.org/blog/?p=588#comment-1378</guid>
		<description>I can only illustrate RestructuredText for a very simple application I write. The old man pages was written directly in troff (or whatever the language is called), I wrote it anew in reST, and it looked just the same, but the source was so much nicer!

Here is the source reST file:

http://kaizer.se/wiki/kupfer-man-rst

Rendered to man looks like this (missing bold, underline and that kind of style here though):

http://kaizer.se/wiki/kupfer-man-out

The program to render it is rst2man.

I think reST is very well specified and as a programmer, easy to understand. A programmer&#039;s editor (such as vim) also makes it easy to format it well (text wrapping and keeping indent is done automatically).</description>
		<content:encoded><![CDATA[<p>I can only illustrate RestructuredText for a very simple application I write. The old man pages was written directly in troff (or whatever the language is called), I wrote it anew in reST, and it looked just the same, but the source was so much nicer!</p>
<p>Here is the source reST file:</p>
<p><a href="http://kaizer.se/wiki/kupfer-man-rst" rel="nofollow">http://kaizer.se/wiki/kupfer-man-rst</a></p>
<p>Rendered to man looks like this (missing bold, underline and that kind of style here though):</p>
<p><a href="http://kaizer.se/wiki/kupfer-man-out" rel="nofollow">http://kaizer.se/wiki/kupfer-man-out</a></p>
<p>The program to render it is rst2man.</p>
<p>I think reST is very well specified and as a programmer, easy to understand. A programmer&#8217;s editor (such as vim) also makes it easy to format it well (text wrapping and keeping indent is done automatically).</p>
]]></content:encoded>
	</item>
	<item>
		<title>By: Richard</title>
		<link>http://www.sharms.org/blog/2009/09/manpages/comment-page-1/#comment-1377</link>
		<dc:creator>Richard</dc:creator>
		<pubDate>Mon, 21 Sep 2009 01:41:23 +0000</pubDate>
		<guid isPermaLink="false">http://www.sharms.org/blog/?p=588#comment-1377</guid>
		<description>I&#039;m not saying that it&#039;s superior. There are definitely formats that are more suitable. However, man is *entrenched* because of a large user base just like many Microsoft products. Again, that is not a value statement. It&#039;s just a statement of fact.



You have a problem with man. Okay, that&#039;s fine. Why don&#039;t you supply patches for every single app out there that change the format to some standard? No? You can write a generator that changes man to XML. How about using a different mode of documenting your software to squeeze man out of the market? Emacs and vim are losing popularity among the new generation of programmers because they grew up on WYSIWYG alternatives.



I don&#039;t write man pages for my apps because my users read documentation online. You can wait until the collective mass of users put market pressure on it to switch because clearly, the status quo is working out for most people.



The world is what it is. You can try to change it or change your way of thinking about things to deal with it. Complaining about it here is not going to start a mass movement.</description>
		<content:encoded><![CDATA[<p>I&#8217;m not saying that it&#8217;s superior. There are definitely formats that are more suitable. However, man is *entrenched* because of a large user base just like many Microsoft products. Again, that is not a value statement. It&#8217;s just a statement of fact.</p>
<p>You have a problem with man. Okay, that&#8217;s fine. Why don&#8217;t you supply patches for every single app out there that change the format to some standard? No? You can write a generator that changes man to XML. How about using a different mode of documenting your software to squeeze man out of the market? Emacs and vim are losing popularity among the new generation of programmers because they grew up on WYSIWYG alternatives.</p>
<p>I don&#8217;t write man pages for my apps because my users read documentation online. You can wait until the collective mass of users put market pressure on it to switch because clearly, the status quo is working out for most people.</p>
<p>The world is what it is. You can try to change it or change your way of thinking about things to deal with it. Complaining about it here is not going to start a mass movement.</p>
]]></content:encoded>
	</item>
	<item>
		<title>By: sharms</title>
		<link>http://www.sharms.org/blog/2009/09/manpages/comment-page-1/#comment-1376</link>
		<dc:creator>sharms</dc:creator>
		<pubDate>Sun, 20 Sep 2009 02:47:05 +0000</pubDate>
		<guid isPermaLink="false">http://www.sharms.org/blog/?p=588#comment-1376</guid>
		<description>Richard,

A lot was different in 1971, but it doesn&#039;t mean it was technically superior nor gained adoption -- I hear betamax was great.

Your analogy is flawed, technology evolves, the idea of manpages is good it just needs a refresh.</description>
		<content:encoded><![CDATA[<p>Richard,</p>
<p>A lot was different in 1971, but it doesn&#8217;t mean it was technically superior nor gained adoption &#8212; I hear betamax was great.</p>
<p>Your analogy is flawed, technology evolves, the idea of manpages is good it just needs a refresh.</p>
]]></content:encoded>
	</item>
	<item>
		<title>By: Richard</title>
		<link>http://www.sharms.org/blog/2009/09/manpages/comment-page-1/#comment-1375</link>
		<dc:creator>Richard</dc:creator>
		<pubDate>Sun, 20 Sep 2009 02:44:15 +0000</pubDate>
		<guid isPermaLink="false">http://www.sharms.org/blog/?p=588#comment-1375</guid>
		<description>If you&#039;re talking about the format, then perhaps you&#039;re unfairly blaming man for not being widely adopted. Its origins (1971) precede the other standards for display and there is a large legacy base of man pages that would have to be needlessly rewritten to switch to another format. It&#039;s not man&#039;s fault for existing and being different.

Your complaint about man would be roughly comparable to a typical American who can only speak English going to Slovenia and complaining that they haven&#039;t adopted English as the official language.

In your case, I would suggest learning man if you want to create man pages or give up and not use it. In any case, it&#039;s unfair to complain about it. The &quot;not enough time&quot; excuse is not really valid since everyone has the same amount of time; it&#039;s just that you value spending time on other things than whatever you do that involves man. Case in point: I&#039;m sure that if some company hired you for a huge contract to make man pages for their product, you&#039;d have no trouble finding time for it.</description>
		<content:encoded><![CDATA[<p>If you&#8217;re talking about the format, then perhaps you&#8217;re unfairly blaming man for not being widely adopted. Its origins (1971) precede the other standards for display and there is a large legacy base of man pages that would have to be needlessly rewritten to switch to another format. It&#8217;s not man&#8217;s fault for existing and being different.</p>
<p>Your complaint about man would be roughly comparable to a typical American who can only speak English going to Slovenia and complaining that they haven&#8217;t adopted English as the official language.</p>
<p>In your case, I would suggest learning man if you want to create man pages or give up and not use it. In any case, it&#8217;s unfair to complain about it. The &#8220;not enough time&#8221; excuse is not really valid since everyone has the same amount of time; it&#8217;s just that you value spending time on other things than whatever you do that involves man. Case in point: I&#8217;m sure that if some company hired you for a huge contract to make man pages for their product, you&#8217;d have no trouble finding time for it.</p>
]]></content:encoded>
	</item>
	<item>
		<title>By: Steven Harms</title>
		<link>http://www.sharms.org/blog/2009/09/manpages/comment-page-1/#comment-1374</link>
		<dc:creator>Steven Harms</dc:creator>
		<pubDate>Thu, 17 Sep 2009 19:03:27 +0000</pubDate>
		<guid isPermaLink="false">http://www.sharms.org/blog/?p=588#comment-1374</guid>
		<description>Daniel,

Tex has more features than required.  I am talking about a minimal subset of HTML would be used.  GROFF is absolutely never the best choice.  It may be your habit, but not the intelligent / pragmatic choice.</description>
		<content:encoded><![CDATA[<p>Daniel,</p>
<p>Tex has more features than required.  I am talking about a minimal subset of HTML would be used.  GROFF is absolutely never the best choice.  It may be your habit, but not the intelligent / pragmatic choice.</p>
]]></content:encoded>
	</item>
	<item>
		<title>By: Daniel Leidert</title>
		<link>http://www.sharms.org/blog/2009/09/manpages/comment-page-1/#comment-1373</link>
		<dc:creator>Daniel Leidert</dc:creator>
		<pubDate>Thu, 17 Sep 2009 10:51:17 +0000</pubDate>
		<guid isPermaLink="false">http://www.sharms.org/blog/?p=588#comment-1373</guid>
		<description>Well, you missed TeX in your list. It is pretty easy to create a manual page in (ROFF, GROFF, troff ... whatever) from XML (via DocBook XML/XSLT) or from TeX.

However, GROFF is alive and developing further, although it might not be your choice. You can of course prefer XML or TeX to write documentation (inlcuding manual pages). But for a short manual page I have learned that it is much easier to write it in GROFF. And for the purpose of providing a manual page for every binary in a Debian package, GROFF is often the best choice. All alternatives need a large dependency chain and require more &quot;writing work&quot;. You don&#039;t need much knowledge of GROFF to write short manual pages. You can even create some nice PDF/PS output via GROFF as the docbook-xsl project prooves.</description>
		<content:encoded><![CDATA[<p>Well, you missed TeX in your list. It is pretty easy to create a manual page in (ROFF, GROFF, troff &#8230; whatever) from XML (via DocBook XML/XSLT) or from TeX.</p>
<p>However, GROFF is alive and developing further, although it might not be your choice. You can of course prefer XML or TeX to write documentation (inlcuding manual pages). But for a short manual page I have learned that it is much easier to write it in GROFF. And for the purpose of providing a manual page for every binary in a Debian package, GROFF is often the best choice. All alternatives need a large dependency chain and require more &#8220;writing work&#8221;. You don&#8217;t need much knowledge of GROFF to write short manual pages. You can even create some nice PDF/PS output via GROFF as the docbook-xsl project prooves.</p>
]]></content:encoded>
	</item>
	<item>
		<title>By: sharms</title>
		<link>http://www.sharms.org/blog/2009/09/manpages/comment-page-1/#comment-1372</link>
		<dc:creator>sharms</dc:creator>
		<pubDate>Wed, 16 Sep 2009 23:53:07 +0000</pubDate>
		<guid isPermaLink="false">http://www.sharms.org/blog/?p=588#comment-1372</guid>
		<description>Richard,

You dont understand.  We are not talking about the presentation, but the format.  Display would be the same.</description>
		<content:encoded><![CDATA[<p>Richard,</p>
<p>You dont understand.  We are not talking about the presentation, but the format.  Display would be the same.</p>
]]></content:encoded>
	</item>
	<item>
		<title>By: Richard</title>
		<link>http://www.sharms.org/blog/2009/09/manpages/comment-page-1/#comment-1371</link>
		<dc:creator>Richard</dc:creator>
		<pubDate>Wed, 16 Sep 2009 22:02:25 +0000</pubDate>
		<guid isPermaLink="false">http://www.sharms.org/blog/?p=588#comment-1371</guid>
		<description>I disagree. You have to realize that many machines run headless, so something like html would be excessive for displaying just text. Man pages are designed for ease of reading on the command line. If you dislike the CLI paradigm, that&#039;s another issue.

As for writing man pages for your applications, there&#039;s nothing preventing you from eschewing that and putting your documentation online.</description>
		<content:encoded><![CDATA[<p>I disagree. You have to realize that many machines run headless, so something like html would be excessive for displaying just text. Man pages are designed for ease of reading on the command line. If you dislike the CLI paradigm, that&#8217;s another issue.</p>
<p>As for writing man pages for your applications, there&#8217;s nothing preventing you from eschewing that and putting your documentation online.</p>
]]></content:encoded>
	</item>
	<item>
		<title>By: Andy Smith</title>
		<link>http://www.sharms.org/blog/2009/09/manpages/comment-page-1/#comment-1370</link>
		<dc:creator>Andy Smith</dc:creator>
		<pubDate>Wed, 16 Sep 2009 13:23:36 +0000</pubDate>
		<guid isPermaLink="false">http://www.sharms.org/blog/?p=588#comment-1370</guid>
		<description>I could support the &quot;man&quot; program supporting different typesetting languages but absolutely do not agree that man pages are the wrong way to distribute simple documentation.

When I am logged in to a machine wanting to know how to use a command, I want to be able to type &quot;man $foo&quot; and find out what the options to $foo are.  I don&#039;t want to have to bring up a web browser or PDF reader.  In my opinion if all &quot;man&quot; would be doing is interpreting HTML or whatever into something readable on a terminal screen then great, but not if the expectation is greater than this.

When it comes to more in-depth documentation on larger software packages then yes it is appropriate in my opinion to go to their web site and read their documentation in HTML format.</description>
		<content:encoded><![CDATA[<p>I could support the &#8220;man&#8221; program supporting different typesetting languages but absolutely do not agree that man pages are the wrong way to distribute simple documentation.</p>
<p>When I am logged in to a machine wanting to know how to use a command, I want to be able to type &#8220;man $foo&#8221; and find out what the options to $foo are.  I don&#8217;t want to have to bring up a web browser or PDF reader.  In my opinion if all &#8220;man&#8221; would be doing is interpreting HTML or whatever into something readable on a terminal screen then great, but not if the expectation is greater than this.</p>
<p>When it comes to more in-depth documentation on larger software packages then yes it is appropriate in my opinion to go to their web site and read their documentation in HTML format.</p>
]]></content:encoded>
	</item>
</channel>
</rss>

