Return-Path: X-Original-To: apmail-trafficserver-dev-archive@www.apache.org Delivered-To: apmail-trafficserver-dev-archive@www.apache.org Received: from mail.apache.org (hermes.apache.org [140.211.11.3]) by minotaur.apache.org (Postfix) with SMTP id A7BC1B1B8 for ; Wed, 18 Jan 2012 04:45:13 +0000 (UTC) Received: (qmail 62230 invoked by uid 500); 18 Jan 2012 04:45:10 -0000 Delivered-To: apmail-trafficserver-dev-archive@trafficserver.apache.org Received: (qmail 62014 invoked by uid 500); 18 Jan 2012 04:45:02 -0000 Mailing-List: contact dev-help@trafficserver.apache.org; run by ezmlm Precedence: bulk List-Help: List-Unsubscribe: List-Post: List-Id: Reply-To: dev@trafficserver.apache.org Delivered-To: mailing list dev@trafficserver.apache.org Received: (qmail 61978 invoked by uid 99); 18 Jan 2012 04:44:57 -0000 Received: from athena.apache.org (HELO athena.apache.org) (140.211.11.136) by apache.org (qpsmtpd/0.29) with ESMTP; Wed, 18 Jan 2012 04:44:57 +0000 X-ASF-Spam-Status: No, hits=-0.7 required=5.0 tests=RCVD_IN_DNSWL_LOW,SPF_PASS X-Spam-Check-By: apache.org Received-SPF: pass (athena.apache.org: domain of jamespeach@me.com designates 17.158.233.227 as permitted sender) Received: from [17.158.233.227] (HELO nk11p99mm-asmtpout006.mac.com) (17.158.233.227) by apache.org (qpsmtpd/0.29) with ESMTP; Wed, 18 Jan 2012 04:44:51 +0000 MIME-version: 1.0 Content-type: text/plain; charset=utf-8 Received: from [10.0.0.9] ([76.102.49.178]) by nk11p03mm-asmtp996.mac.com (Oracle Communications Messaging Server 7u4-23.01(7.0.4.23.0) 64bit (built Aug 10 2011)) with ESMTPSA id <0LXZ001KE95JGH50@nk11p03mm-asmtp996.mac.com> for dev@trafficserver.apache.org; Wed, 18 Jan 2012 04:44:11 +0000 (GMT) Subject: Re: user level man pages From: James Peach In-reply-to: <377522e0-cfd9-4315-b0b2-fc7774103ba0@iris> Date: Tue, 17 Jan 2012 20:44:08 -0800 Content-transfer-encoding: quoted-printable Message-id: <3DC539D3-5D0F-4C60-8800-335C56F37459@me.com> References: <377522e0-cfd9-4315-b0b2-fc7774103ba0@iris> To: dev@trafficserver.apache.org X-Mailer: Apple Mail (2.1251.1) On 15/01/2012, at 10:27 PM, Igor Gali=C4=87 wrote: >=20 >=20 > ----- Original Message ----- >> Hi all, >>=20 >> I noticed that there are man pages in doc/man, but these largely >> consist of documentation for the traffic_shell tool. It strikes me >=20 > I suppose the reason is that putting everything in one man page > makes it terribly awful for navigating. > Compare bash's and zsh's man pages. IMHO it's unlikely that anyone doing "man exit" is looking for the = traffic_shell subcommand ;) >> as a little odd for all the sub commands to have their own man page. >> The build does not install these, and the corresponding Makefile.am >> seems to have bitrotted. >>=20 >> Is there any interest in having man pages for user/admin >> documentation? or are these planned for the doxygen build? >=20 > I'm afraid there's nothing concrete planned, but whatever helps > us get to a status of where those are usable again is highly > appreciated. >=20 > I suggest communicating your plans either in the STATUS file > (the docs have their own) -- in a project proposal in the wiki >=20 > https://cwiki.apache.org/confluence/display/TS/Projects = https://cwiki.apache.org/confluence/display/TS/User+Interface+Improvements= >=20 >> J >=20 >=20 > i >=20 > -- > Igor Gali=C4=87 >=20 > Tel: +43 (0) 664 886 22 883 > Mail: i.galic@brainsware.org > URL: http://brainsware.org/ > GPG: 6880 4155 74BD FD7C B515 2EA5 4B1D 9E08 A097 C9AE >=20