diff mbox series

[1/4] docs: Add initial fw_printenv(1) manpage

Message ID 20210411164435.26361-2-andreas@fatal.se
State Changes Requested
Headers show
Series manpages in scdoc format | expand

Commit Message

Andreas Henriksson April 11, 2021, 4:44 p.m. UTC 
This is scdoc source that needs to be compiled into roff formatted
manpage before installation.

Signed-off-by: Andreas Henriksson <andreas@fatal.se>
---
 docs/fw_printenv.1.scd | 82 ++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 82 insertions(+)
 create mode 100644 docs/fw_printenv.1.scd

Comments

Stefano Babic April 12, 2021, 9:20 a.m. UTC | #1 
Hi Andreas,

On 11.04.21 18:44, Andreas Henriksson wrote:
> This is scdoc source that needs to be compiled into roff formatted
> manpage before installation.
> 
> Signed-off-by: Andreas Henriksson <andreas@fatal.se>
> ---
>   docs/fw_printenv.1.scd | 82 ++++++++++++++++++++++++++++++++++++++++++
>   1 file changed, 82 insertions(+)
>   create mode 100644 docs/fw_printenv.1.scd
> 
> diff --git a/docs/fw_printenv.1.scd b/docs/fw_printenv.1.scd
> new file mode 100644
> index 0000000..8883d12
> --- /dev/null
> +++ b/docs/fw_printenv.1.scd
> @@ -0,0 +1,82 @@
> +fw_printenv(1) "April 2021" "libubootenv"
> +
> +# SYNOPSIS
> +
> +*fw_printenv* [option...] [variable...]
> +
> +# DESCRIPTION
> +
> +This program provides a convenient way to access, parse and print out
> +the content of the U-Boot environment in a fully booted up system.
> +
> +It is similar to the *printenv* command available in the u-boot shell.

Well, we can consider it as 'printenv' for user space.

> +
> +# OPTIONS
> +
> +*-c, --config* <filename>
> +	configuration file (default: /etc/fw_env.config)
> +
> +*-f, --defenv* <filename>
> +	default environment if no one found
> +	(default: /etc/u-boot-initial-env)

> +
> +*-h*
> +	print the help message and exit
> +
> +*-n, --no-header*
> +	do not print variable name (only content)
> +
> +*-V*
> +	print version and exit
> +
> +# EXAMPLES
> +
> +print entire environment content:
> +
> +```
> +# fw_printenv
> +apa=bepa
> +foo=bar
> +lala=baba
> +sasa=dada

Well, we can write some common variables instead of phantasy name. For 
example:

bootcmd=run nandboot;run swupdate
bootdelay=3
bootfile=uImage
bootimage=uImage
bootlimit=3


> +```
> +
> +print specific variables:
> +
> +```
> +# fw_printenv foo lala
> +foo=bar
> +lala=baba
> +```
> +
> +print only content of a variable:
> +
> +```
> +# fw_printenv -n foo
> +bar
> +```
> +
> +# EXIT STATUS
> +
> +On success, 0 is returned, a non-zero failure code otherwise.
> +
> +# FILES
> +
> +*/etc/fw_env.config*
> +	The default configuration path. Describes where the u-boot
> +	environment lives. See *fw_env.config*(5) for detailed info.
> +
> +*/etc/u-boot-initial-env*
> +	The default u-boot environment to use if the location described
> +	in *fw_env.config* is uninitialized (or corrupted).


It should be added that the file is a simple ASCII and it is like the 
output of fw_printenv, with <VAR>=<VALUE>

> +
> +# SEE ALSO
> +
> +*fw_env.config*(5), *fw_setenv*(1)
> +
> +# HISTORY
> +
> +The original implementation of the *fw_printenv* and *fw_setenv* tools lived
> +inside the u-boot repository. The version you're currently reading about is a
> +re-implementation of these tools, based on the *libubootenv* library.
> +
> 

Best regards,
Stefano Babic
diff mbox series

Patch

diff --git a/docs/fw_printenv.1.scd b/docs/fw_printenv.1.scd
new file mode 100644
index 0000000..8883d12
--- /dev/null
+++ b/docs/fw_printenv.1.scd
@@ -0,0 +1,82 @@ 
+fw_printenv(1) "April 2021" "libubootenv"
+
+# SYNOPSIS
+
+*fw_printenv* [option...] [variable...]
+
+# DESCRIPTION
+
+This program provides a convenient way to access, parse and print out
+the content of the U-Boot environment in a fully booted up system.
+
+It is similar to the *printenv* command available in the u-boot shell.
+
+# OPTIONS
+
+*-c, --config* <filename>
+	configuration file (default: /etc/fw_env.config)
+
+*-f, --defenv* <filename>
+	default environment if no one found
+	(default: /etc/u-boot-initial-env)
+
+*-h*
+	print the help message and exit
+
+*-n, --no-header*
+	do not print variable name (only content)
+
+*-V*
+	print version and exit
+
+# EXAMPLES
+
+print entire environment content:
+
+```
+# fw_printenv
+apa=bepa
+foo=bar
+lala=baba
+sasa=dada
+```
+
+print specific variables:
+
+```
+# fw_printenv foo lala
+foo=bar
+lala=baba
+```
+
+print only content of a variable:
+
+```
+# fw_printenv -n foo
+bar
+```
+
+# EXIT STATUS
+
+On success, 0 is returned, a non-zero failure code otherwise.
+
+# FILES
+
+*/etc/fw_env.config*
+	The default configuration path. Describes where the u-boot
+	environment lives. See *fw_env.config*(5) for detailed info.
+
+*/etc/u-boot-initial-env*
+	The default u-boot environment to use if the location described
+	in *fw_env.config* is uninitialized (or corrupted).
+
+# SEE ALSO
+
+*fw_env.config*(5), *fw_setenv*(1)
+
+# HISTORY
+
+The original implementation of the *fw_printenv* and *fw_setenv* tools lived
+inside the u-boot repository. The version you're currently reading about is a
+re-implementation of these tools, based on the *libubootenv* library.
+