From mboxrd@z Thu Jan 1 00:00:00 1970 Received: from list by lists.gnu.org with archive (Exim 4.71) id 1U48uC-0007hP-MP for mharc-grub-devel@gnu.org; Sat, 09 Feb 2013 06:47:40 -0500 Received: from eggs.gnu.org ([208.118.235.92]:33948) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1U48u7-0007d6-P1 for grub-devel@gnu.org; Sat, 09 Feb 2013 06:47:39 -0500 Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1U48u0-0003Dz-R4 for grub-devel@gnu.org; Sat, 09 Feb 2013 06:47:35 -0500 Received: from mail-ea0-f179.google.com ([209.85.215.179]:45345) by eggs.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1U48u0-0003De-I1 for grub-devel@gnu.org; Sat, 09 Feb 2013 06:47:28 -0500 Received: by mail-ea0-f179.google.com with SMTP id d12so1917496eaa.38 for ; Sat, 09 Feb 2013 03:47:27 -0800 (PST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20120113; h=x-received:message-id:date:from:user-agent:mime-version:to:subject :references:in-reply-to:content-type:content-transfer-encoding; bh=6J/BNH91/5Yimpxf1qn7jn/4Fbo0bp6h+TGjM0ugug0=; b=wk2ZmbI1D8aTARgBe41BUf4SneIVqpSjvBSGrLqYlwM5XOFGC1HJRhX17CYYBDFUS9 m1yPcK3uT5wK5iPIidPN2m16w40m9OK7UFY+U8TwGwWVRuqld14Cc2y1Ff3zkFRWHniu BGwNk+7QnXJaHgzSvytYIv8+JFkY38xUIkvJoO0RlajvbWSij1udpX8otSQeBpOJC5RO lj8D1sNAmcQc9aGiVmv+YejTiZKLCZMHIt+nUU14x93CR9qa8fn9T2wsdjJ2n62GWtyA R7vY9mmnQPe+DKIIdbUHj/9nMjN8l8UTwPxOgu5ze3sJfIcVgfJaWwjz+fPQ2BO6f8vs 6mgw== X-Received: by 10.14.193.131 with SMTP id k3mr26783956een.45.1360410447036; Sat, 09 Feb 2013 03:47:27 -0800 (PST) Received: from [192.168.56.2] (adsl-ull-85-99.47-151.net24.it. [151.47.99.85]) by mx.google.com with ESMTPS id j46sm48579479eeo.3.2013.02.09.03.47.25 (version=TLSv1 cipher=ECDHE-RSA-RC4-SHA bits=128/128); Sat, 09 Feb 2013 03:47:26 -0800 (PST) Message-ID: <51163783.7030006@gmail.com> Date: Sat, 09 Feb 2013 12:48:19 +0100 From: Francesco Lavra User-Agent: Mozilla/5.0 (X11; Linux i686; rv:7.0.1) Gecko/20110929 Thunderbird/7.0.1 MIME-Version: 1.0 To: grub-devel@gnu.org Subject: Re: Command documentation part 1. References: <20130122170851.1bb50f87@opensuse.site> <20130122171218.GA9543@riva.dynamic.greenend.org.uk> <20130129142517.44838703@opensuse.site> In-Reply-To: <20130129142517.44838703@opensuse.site> Content-Type: text/plain; charset=KOI8-R Content-Transfer-Encoding: 8bit X-detected-operating-system: by eggs.gnu.org: GNU/Linux 3.x [fuzzy] X-Received-From: 209.85.215.179 X-BeenThere: grub-devel@gnu.org X-Mailman-Version: 2.1.14 Precedence: list Reply-To: The development of GNU GRUB List-Id: The development of GNU GRUB List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , X-List-Received-Date: Sat, 09 Feb 2013 11:47:39 -0000 Hi, On 01/29/2013 11:25 AM, Andrey Borzenkov wrote: > В Tue, 22 Jan 2013 17:12:18 +0000 > Colin Watson пишет: > >> On Tue, Jan 22, 2013 at 05:08:51PM +0400, Andrey Borzenkov wrote: >>> Quit a number of commands are not documented. Is it intentional >>> (because they are not considered "user level API")? Should >>> documentation for them go into grub or grub-dev? >> >> I spent some time documenting the list of commands a while back, but I >> never completed the project: what you're seeing is simply how far I got >> before getting distracted by other things. IMO all commands should be >> documented in grub.texi. >> > > Below is attempt to document most of user-relevant commands (I may have > missed a couple of them). Please review (formatting, language). > > What is left are > > - new file signature checks. I need some time to understand how to > describe them > > - non-Linux loaders. I do not have experience myself, so it will need > some help probably > > - the rest of commands which are more or less low-level, not normally > expected to be used daily. I have the following suggestion: > > * merge General commands and Command-line and menu entry commands into > General commands. Current split seems to be artificial. Let normal > user commands go into this section > > * Add Advanced commands section where all the more exotic ones are described. > > Does it make sense? > > Patch follows > > From: Andrey Borzenkov > Subject: [PATCH] document grub commands > > Add documentation for grub commands > > Signed-off-by: Andrey Borzenkov > > --- > docs/grub.texi | 262 +++++++++++++++++++++++++++++++++++++++++++++++++++++++- > 1 file changed, 259 insertions(+), 3 deletions(-) > > diff --git a/docs/grub.texi b/docs/grub.texi > index 9941b47..8329ee1 100644 > --- a/docs/grub.texi > +++ b/docs/grub.texi [...] > +@node background_image > +@subsection background_image > + > +@deffn Command background_image [[@option{--mode} @samp{stretch}|@samp{normal}] file] > +Load background image for active terminal from @var{file}. Image is stretched > +to fill up entire screen unless option @option{--mode} @samp{normal} is given. > +Without agruments remove currently loaded background image. s/agruments/arguments [...] > +@node cryptomount > +@subsection cryptomount > + > +@deffn Command cryptomount device|@option{-u} uuid|@option{-a}|@option{-b} > +Setup access to encrypted device. If neccessary, passphrase s/neccessary/necessary [...] > +@node sleep > +@subsection sleep > + > +@deffn Command sleep [@option{--verbose}] [@option{--interruptible}] count > +Sleep for @var{count} of seconds. If option @option{--interruptible} is given, The word "of" should be removed (Sleep for @var{count} seconds.) > +allow @key{ESC} to interrupt sleep. With @option{--verbose} show countdown > +of remaining seconds. > +@end deffn > + > + > @node source > @subsection source > > @@ -4147,6 +4318,74 @@ will not be shown immediately. > @end deffn > > > +@node test > +@subsection test > + > +@deffn Command test expression > +Evaluate @var{expression} and return zero exit status if result is true, > +non zero status otherwise. > + > +@var{expression} is one of: > + > +@table @asis > +@item @var{string1} @code{==} @var{string2} > +the strings are equal > +@item @var{string1} @code{!=} @var{string2} > +the strings are not equal > +@item @var{string1} @code{<} @var{string2} > +@var{string1} is lexicographically less than @var{string2} > +@item @var{string1} @code{<=} @var{string2} > +@var{string1} is lexicographically less or equal than @var{string2} > +@item @var{string1} @code{>} @var{string2} > +@var{string1} is lexicographically greater than @var{string2} > +@item @var{string1} @code{<=} @var{string2} <= should be >= > +@var{string1} is lexicographically greater or equal than @var{string2} [...] > +@node videoinfo > +@subsection videoinfo > + > +@deffn Command videoinfo [[WxH]xD] > +List available video modes. If resolution is given, show only mathing modes. s/mathing/matching Regards, Francesco