From mboxrd@z Thu Jan 1 00:00:00 1970 Message-ID: <5d375e920711020053g1407d937n95a6a01c9c8692bb@mail.gmail.com> Date: Fri, 2 Nov 2007 08:53:04 +0100 From: Uriel To: "Fans of the OS Plan 9 from Bell Labs" <9fans@cse.psu.edu> Subject: Re: [9fans] Suggestion: Programming Tutorial for /sys/doc In-Reply-To: <509071940711011844w6d2c8ff3r8046b40be55a30ce@mail.gmail.com> MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 7bit Content-Disposition: inline References: <02597431-3833-4DDD-8720-E0B2761DBE88@mac.com> <509071940711011347i27feaf1bmf12b6c2358818fd8@mail.gmail.com> <2552D0A5-2008-4E64-BDDA-A62812CA2E33@mac.com> <509071940711011844w6d2c8ff3r8046b40be55a30ce@mail.gmail.com> Topicbox-Message-UUID: e5b73084-ead2-11e9-9d60-3106f5b1d025 > > The man pages have several flaws: there are too many; > > Again, I'm afraid I don't really understand this complaint. They are > numerous, yes, because they're describing lots of different things. > They don't make for the best introduction *on their own* for that > reason, but they make an excellent reference - which is more or less > their intent. There is intro(2) is not a bad introduction either, althought it certainly doesn't cover much. Just thinking out loud here so I might make no sense, but I suspect the issue is that the style of the plan9 documentation is very different from what people have become used to expect, this days people expects 'tutorials' and other handholding with many examples to 'copy paste' into their code and so on, which is quite different from the Unix/Plan 9 documentation style of clear and concise information and simple examples that help illustrate the general concepts, but that does require the reader to actually *understand* things rather than just follow an arbitrary set of steps. Best wishes uriel > > > some important stuff is hard to find; > > Sometimes, yes. lookman does a very good job, but is not perfect. Can > you give examples of the types of difficulty you've been having? > > > "man page jumping" is a problem. > > Why? It's certainly easy enough to do - the acme integration via > plumber is very nice. It's a "problem" in that it doesn't make for a > nice, flowing introduction, but again, that's not their intent. > > My point about the man pages as regards an introductory document is > mostly that it'd be bad to needlessly duplicate effort. I'd expect an > introductory document to make extensive reference to the manual for > the topics it covers. >