Re: Command documentation part 1.

["Vladimir 'φ-coder/phcoder' Serbinenko" <phcoder@gmail.com>]

[-- Attachment #1: Type: text/plain, Size: 5206 bytes --]

On 24.02.2013 08:40, Andrey Borzenkov wrote:

>  
>  @menu
> +* [::                           Check file types and compare values
>  * acpi::                        Load ACPI tables
> +* authenticate::                Check whether user is in user list
> +* background_color::            Set background color for active terminal
> +* background_image::            Load background image for active terminal

These are specific to gfxterm, not generic how your patch would suggest.
> +* md5sum::                      Calculate MD5 hash
It also checks. This is an alias to hashsum

> +* sha1sum::                     Calculate SHA1 hash
> +* sha256sum::                   Calculate SHA256 hash
> +* sha512sum::                   Calculate SHA512 hash

ditto

> +* vbeinfo::                     List available video modes

vbeinfo is a compatibility alias and is reserved for VBE.
Perhaps we should start having commands specifically excluded from help
lists to discourage their use

> +@node background_color
> +@subsection background_color
> +
> +@deffn Command background_color color
> +Set background color for active terminal. For valid color specifications see
> +@pxref{Theme file format, ,Colors}.
> +@end deffn
> +
> +
> +@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 arguments remove currently loaded background image.
> +@end deffn

Ditto. gfxterm-specific

> +@node cmosclean
> +@subsection cmosclean
> +
> +@deffn Command cmosclean byte:bit
> +Clear value of bit in CMOS at location @var{byte}:@var{bit}.  This command
> +is available only on PC BIOS platform.
> +@end deffn

It's available on all platforms featuring CMOS which are all x86
(including EFI, coreboot, ieeee1275, and so on), Loongson, Qemu-mips and
some IEEE1275 platforms (determined at runtime).

GROUPS["cmos"] = GROUPS["x86"][:] + ["mips_loongson", "mips_qemu_mips",
                                     "sparc64_ieee1275", "powerpc_ieee1275"]

> +

> +
> +@node cmostest
> +@subsection cmostest
> +
> +@deffn Command cmostest byte:bit
> +Test value of bit in CMOS at location @var{byte}:@var{bit}. Exit status
> +is zero if bit is set, non zero otherwise. This command is available only
> +on PC BIOS platform.
> +@end deffn
> +

Ditto.

> -@deffn Command crc file
> -Display the CRC32 checksum of @var{file}.
> +@deffn Command crc arg @dots{}
> +Alias for @code{hashsum --hash crc32 arg @dots{}}. See command @command{hashsum}
> +(@pxref{hashsum}) for full description.
> +@end deffn
> +
> +
> +@node cryptomount
> +@subsection cryptomount
> +
> +@deffn Command cryptomount device|@option{-u} uuid|@option{-a}|@option{-b}
> +Setup access to encrypted device. If necessary, passphrase
> +is requested interactively. Option @var{device} configures specific grub device
> +(@pxref{Naming convention}); option @option{-u} @var{uuid} configures device
> +with specified @var{uuid}; option @option{-a} configures all encrypted devices;

Only the ones GRUB supports

> +option @option{-b} configures all partitions that have boot flag set.

Last part is wrong. It refers to boot flag in geli container, not the
one in partmap.
Also I think it's worth mentioning that luks/geli/... aren't autoloaded.

> +@node hashsum
> +@subsection hashsum
> +
> +@deffn Command hashsum @option{--hash} hash @option{--keep-going} @option{--uncompress} @option{--check} file [@option{--prefix} dir]|file @dots{}
> +Compute or verify file hashes. Hash type is selected with option @option{--hash}.
> +Supported hashes are @samp{crc32}, @samp{md5}, @samp{sha1}, @samp{sha256},
> +@samp{sha512}.

Much more hashes are supported. Currently:

ADLER32: adler32
CRC64: crc64
CRC32: gcry_crc
CRC32RFC1510: gcry_crc
CRC24RFC2440: gcry_crc
MD4: gcry_md4
MD5: gcry_md5
RIPEMD160: gcry_rmd160
SHA1: gcry_sha1
SHA224: gcry_sha256
SHA256: gcry_sha256
SHA512: gcry_sha512
SHA384: gcry_sha512
TIGER192: gcry_tiger
TIGER: gcry_tiger
TIGER2: gcry_tiger
WHIRLPOOL: gcry_whirlpool

> +When option @option{--check} is given, it points to a file that contains
> +list of @var{hash name} pairs. File hash and file name are separated by
> +single @key{SPACE} or @key{TAB}, one pair on a line. Option @option{--prefix}
> +may be used to give directory where files are located. Hash verification
> +stops after the first mismatch was found unless option @option{--keep-going}
> +was given.
> +@end deffn

This is the same format as used by standard UNIX tools.

> @@ -4147,6 +4372,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:


Did you copy it from somewhere else? Please specify all parts copied
from anywhere else.


[-- Attachment #2: OpenPGP digital signature --]
[-- Type: application/pgp-signature, Size: 294 bytes --]