From owner-freebsd-doc@FreeBSD.ORG Tue Sep 7 17:00:43 2010 Return-Path: Delivered-To: freebsd-doc@freebsd.org Received: from mx1.freebsd.org (mx1.freebsd.org [IPv6:2001:4f8:fff6::34]) by hub.freebsd.org (Postfix) with ESMTP id 60289106564A for ; Tue, 7 Sep 2010 17:00:43 +0000 (UTC) (envelope-from coco@executive-computing.de) Received: from mail.moehre.org (mail.moehre.org [195.96.35.7]) by mx1.freebsd.org (Postfix) with ESMTP id D3D918FC16 for ; Tue, 7 Sep 2010 17:00:42 +0000 (UTC) Received: from mail.moehre.org (unknown [195.96.35.7]) by mail.moehre.org (Postfix) with ESMTP id 642DE8B143A for ; Tue, 7 Sep 2010 18:45:37 +0200 (CEST) X-Spam-Flag: NO X-Spam-Score: -100.992 X-Spam-Level: X-Spam-Status: No, score=-100.992 tagged_above=-999 required=5 tests=[ALL_TRUSTED=-1, AWL=0.008, USER_IN_WHITELIST=-100] autolearn=disabled Received: from mail.moehre.org ([195.96.35.7]) by mail.moehre.org (mail.moehre.org [195.96.35.7]) (amavisd-new, port 10024) with ESMTP id OmRaYXnOYJdk for ; Tue, 7 Sep 2010 18:45:35 +0200 (CEST) Received: from [192.168.100.35] (p54B09BA2.dip.t-dialin.net [84.176.155.162]) (using TLSv1 with cipher DHE-RSA-AES256-SHA (256/256 bits)) (No client certificate requested) (Authenticated sender: coco@executive-computing.de) by mail.moehre.org (Postfix) with ESMTPSA id 460C28B1435 for ; Tue, 7 Sep 2010 18:45:34 +0200 (CEST) Message-ID: <4C866B33.5050800@executive-computing.de> Date: Tue, 07 Sep 2010 18:41:23 +0200 From: Marco Steinbach User-Agent: Thunderbird 2.0.0.21 (Windows/20090302) MIME-Version: 1.0 To: freebsd-doc@freebsd.org Content-Type: text/plain; charset=ISO-8859-15; format=flowed Content-Transfer-Encoding: 7bit Subject: man pages: Keyboard shortcuts/keys and other style questions X-BeenThere: freebsd-doc@freebsd.org X-Mailman-Version: 2.1.5 Precedence: list List-Id: Documentation project List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , X-List-Received-Date: Tue, 07 Sep 2010 17:00:43 -0000 Hello. I'm currently preparing a man page for a yet to be submited new port, and altough I was able to get answers for some of my questions from the mdoc(7) man page and other sources, there are still some areas where I am not sure about how to properly format and label things. If this list is not the right place to post such questions, I'd appreciate any pointers (e.g. -ports ?). The current source of the man page is available at http://www.moehre.org/files/sqtop/sqtop.1 The port has an optional ncurses-based interface, which, if used, allows the behaviour of the utility to be changed by pressing certain keys. - Is "INTERACTIVE MODE" the appropiate term to be used as heading for the section dealing with the specifics of a ncurses-based user interface ? - What labels are to be used for keys which usually do not produce a printable character ? E.g. is the -key to be represented as "return", "" or "RETURN" (or is it to be named "enter", anyway ?) - What about the cursor movement and other directional keys like , , ? - Are there any preferences for the macros to use for keys to be pressed, e.g. is the following acceptable: .Bl -tag -width Fl .It Ic C Do the C thing. .It Ic A Do the A thing. .El Any hints and suggestions (wording, macro usage, etc) to make the man page a better fit to the style of the FreeBSD project are greatly appreciated. MfG CoCo