From mboxrd@z Thu Jan 1 00:00:00 1970 Received: from list by lists.gnu.org with archive (Exim 4.71) id 1axTp6-000782-Ab for mharc-grub-devel@gnu.org; Tue, 03 May 2016 02:28:44 -0400 Received: from eggs.gnu.org ([2001:4830:134:3::10]:58999) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1axToy-0006tu-Lo for grub-devel@gnu.org; Tue, 03 May 2016 02:28:43 -0400 Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1axTom-0004GF-QD for grub-devel@gnu.org; Tue, 03 May 2016 02:28:31 -0400 Received: from mail-lf0-x233.google.com ([2a00:1450:4010:c07::233]:32998) by eggs.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1axTol-00047i-FA for grub-devel@gnu.org; Tue, 03 May 2016 02:28:24 -0400 Received: by mail-lf0-x233.google.com with SMTP id y84so10665382lfc.0 for ; Mon, 02 May 2016 23:28:09 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20120113; h=subject:to:references:from:message-id:date:user-agent:mime-version :in-reply-to:content-transfer-encoding; bh=ZlZdLgmQ2c8w4+Bd/00MVFN3L4u1+uB/va3HEnhH7Ns=; b=srGGjz5GlxBC9AWNK+FxaxOG+q9sNkbfddRS1z8DXhxkeDNnrVd/hZMf7NOQJ3IZ+j a7aP7/gYGfZn/J2H9U3Crd/Q4d1WOCz3YRRsqOiu8fcHf0cXg1TWSOEIogHrHkZD2inI jlAQAaf4j5G3zgg3FaIXi9eqRy2UMiiIasI+aGNJ8CWE4QOIEbAioSG+1ZaxAKMx3B6b 0Kvu1UbAN9Eq0j2GTCixXi2ZoJHtNOkhoLVJRN1xxove+M+pFgnJxmjF8Isz1UMEw8Kh l1SkJq2KybKoaFaEL7R2KxDR0XOTtt33osWB/8jDymiLYYjiv4FqrfLBWIB9MhSNq+0Q fAMA== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20130820; h=x-gm-message-state:subject:to:references:from:message-id:date :user-agent:mime-version:in-reply-to:content-transfer-encoding; bh=ZlZdLgmQ2c8w4+Bd/00MVFN3L4u1+uB/va3HEnhH7Ns=; b=bBrSU7/SR2oDdIjEagrVFtOjzg1at6a2KBUBcBzKJ2X0brHfE2V62TuZ3r2Vx+lwCW zUwukgGFahDWTyYc9HdWyKfcIWPIEpgOaBBbua4gbUuDiT3w7ZHTakgeFAlwS6LWXyno dSBOvScrRlqAG0JAoZ0K0+gXvacsGxbGfwkTCcjjmu7Od81KB42AM8BdTEIx89b/ZgNJ saOcbRZPoY6oZh/JEDb63ghtE0jPG6xpKiuROXmJQ4/CPNQNAPctZezNc6lNDpfhLYbX eAJXksJS9bWzwhxyFOiVkqA1MtVbQfQC8LLXXpokyOM7FRZ2CW2hkv9+TdmAaTMt5FB/ ijZg== X-Gm-Message-State: AOPr4FWCWZSh2Gj1DasM2Az8s8e7E8A5QvO1A1oefAo4eX2CKB3f7wkXkqj81orZd1mM8Q== X-Received: by 10.25.78.204 with SMTP id c195mr326810lfb.21.1462256885238; Mon, 02 May 2016 23:28:05 -0700 (PDT) Received: from [192.168.1.42] (ppp109-252-90-74.pppoe.spdop.ru. [109.252.90.74]) by smtp.gmail.com with ESMTPSA id n13sm270179lfb.28.2016.05.02.23.28.03 for (version=TLSv1/SSLv3 cipher=OTHER); Mon, 02 May 2016 23:28:04 -0700 (PDT) Subject: Re: man page improvements To: The development of GNU GRUB References: From: Andrei Borzenkov X-Enigmail-Draft-Status: N1110 Message-ID: <572844F3.9030107@gmail.com> Date: Tue, 3 May 2016 09:28:03 +0300 User-Agent: Mozilla/5.0 (X11; Linux x86_64; rv:38.0) Gecko/20100101 Thunderbird/38.7.2 MIME-Version: 1.0 In-Reply-To: Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit X-detected-operating-system: by eggs.gnu.org: GNU/Linux 2.2.x-3.x [generic] X-Received-From: 2a00:1450:4010:c07::233 X-BeenThere: grub-devel@gnu.org X-Mailman-Version: 2.1.21 Precedence: list List-Id: The development of GNU GRUB List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , X-List-Received-Date: Tue, 03 May 2016 06:28:43 -0000 30.04.2016 12:48, Andrew Worsley пишет: > I would like to improve the man pages as they are very brief and not that > helpful for in-experienced users who may be trying to do simple recoveries > or setup from a recovery disk. > > I have discovered that the manual pages are auto-generated via help2man > from the command usage information. > > So not wanting to waste my time or other people I thought I should ask > about what would be acceptable prior to do significant work. > I would rather see time spent on improving texinfo documentation. > I understand that any extensions might create additional work for > translators. > > I am suggesting either: > > 1. A generic top level man page "grub.1 "which you get by running "man > grub" that gives a summary of all the commands plus a brief summary on how > to perform basic install and recovery. > We have texinfo documentation for it. I do not see any need to duplicate efforts (we do not have that much resources). > Or > > 2. Extending the --help information of each command with a basic example or > two of usage. > Again we have texinfo for it. Explaining how to use GRUB does need more than basic example or two, so man page format is simply unsuitable for it. If you are willing to help, I suggest you start with documenting four basic end-user commands - grub-install, grub-mknetboot, grub-mkstandalone, grub-mkrescue, with nice cross-references to/from other parts of texinfo as appropriate. Thank you. > Thanks > > Andrew > > > > _______________________________________________ > Grub-devel mailing list > Grub-devel@gnu.org > https://lists.gnu.org/mailman/listinfo/grub-devel >