Patchwork [2/3] doc: addition of fwts-frontend-text man page

login
register
mail settings
Submitter Chris Van Hoof
Date Jan. 28, 2012, 8:39 p.m.
Message ID <1327783158-24282-2-git-send-email-vanhoof@canonical.com>
Download mbox | patch
Permalink /patch/138411/
State Accepted
Headers show

Comments

Chris Van Hoof - Jan. 28, 2012, 8:39 p.m.
Signed-off-by: Chris Van Hoof <vanhoof@canonical.com>
---
 doc/fwts-frontend-text.1 |   65 ++++++++++++++++++++++++++++++++++++++++++++++
 1 files changed, 65 insertions(+), 0 deletions(-)
 create mode 100644 doc/fwts-frontend-text.1
Keng-Yu Lin - Jan. 30, 2012, 10:20 a.m.
On Sun, Jan 29, 2012 at 4:39 AM, Chris Van Hoof <vanhoof@canonical.com> wrote:
> Signed-off-by: Chris Van Hoof <vanhoof@canonical.com>
> ---
>  doc/fwts-frontend-text.1 |   65 ++++++++++++++++++++++++++++++++++++++++++++++
>  1 files changed, 65 insertions(+), 0 deletions(-)
>  create mode 100644 doc/fwts-frontend-text.1
>
> diff --git a/doc/fwts-frontend-text.1 b/doc/fwts-frontend-text.1
> new file mode 100644
> index 0000000..14e4a5b
> --- /dev/null
> +++ b/doc/fwts-frontend-text.1
> @@ -0,0 +1,65 @@
> +.\"                                      Hey, EMACS: -*- nroff -*-
> +.\" First parameter, NAME, should be all caps
> +.\" Second parameter, SECTION, should be 1-8, maybe w/ subsection
> +.\" other parameters are allowed: see man(7), man(1)
> +.TH FWTS-FRONTEND 1 "January 26, 2012"
> +.\" Please adjust this date whenever revising the manpage.
> +.\"
> +.\" Some roff macros, for reference:
> +.\" .nh        disable hyphenation
> +.\" .hy        enable hyphenation
> +.\" .ad l      left justify
> +.\" .ad b      justify to both left and right margins
> +.\" .nf        disable filling
> +.\" .fi        enable filling
> +.\" .br        insert line break
> +.\" .sp <n>    insert n+1 empty lines
> +.\" for manpage-specific macros, see man(7)
> +.SH NAME
> +fwts-frontend-text \- text based interface to fwts.
> +.br
> +
> +.SH SYNOPSIS
> +.B fwts-frontend-text
> +.br
> +
> +.SH DESCRIPTION
> +This manual page briefly documents the
> +.B fwts-frontend-text
> +utility.
> +The tool
> +.B fwts-frontend-text
> +executes a user-friendly interface to the Firmware Test Suite, providing the
> +user a simple interface to execute all batch tests or the ability to select
> +individual tests to execute.
> +.B
> +fwts-frontend-text
> +should be run with root priviledge, for example using sudo.
> +.br
> +.LP
> +Running
> +.B
> +fwts-frontend-text
> +with the argument noautoshutdown will prevent the system
> +from shutting down after tests have been executed.
> +.P
> +.SH EXAMPLES
> +.LP
> +Execute fwts-frontend-text
> +.RS 8
> +sudo fwts-frontend-text
> +.RE
> +.LP
> +Execute fwts-frontend-text and disable automatic shutdown
> +.RS 8
> +sudo fwts-frontend-text noautoshutdown
> +.SH SEE ALSO
> +.BR fwts (1),
> +.BR dmidecode (8),
> +.BR lspci (8)
> +.SH AUTHOR
> +fwts-frontend-text was written by Colin King <colin.king@canonical.com>,
> +and Chris Van Hoof <vanhoof@canonical.com>
> +.PP
> +This manual page was written by Chris Van Hoof <vanhoof@canonical.com>,
> +for the Ubuntu project (but may be used by others).
> --
> 1.7.8.3
>
>
Acked-by: Keng-Yu Lin <kengyu@canonical.com>
Colin King - Feb. 9, 2012, 9:30 a.m.
On 28/01/12 20:39, Chris Van Hoof wrote:
> Signed-off-by: Chris Van Hoof<vanhoof@canonical.com>
> ---
>   doc/fwts-frontend-text.1 |   65 ++++++++++++++++++++++++++++++++++++++++++++++
>   1 files changed, 65 insertions(+), 0 deletions(-)
>   create mode 100644 doc/fwts-frontend-text.1
>
> diff --git a/doc/fwts-frontend-text.1 b/doc/fwts-frontend-text.1
> new file mode 100644
> index 0000000..14e4a5b
> --- /dev/null
> +++ b/doc/fwts-frontend-text.1
> @@ -0,0 +1,65 @@
> +.\"                                      Hey, EMACS: -*- nroff -*-
> +.\" First parameter, NAME, should be all caps
> +.\" Second parameter, SECTION, should be 1-8, maybe w/ subsection
> +.\" other parameters are allowed: see man(7), man(1)
> +.TH FWTS-FRONTEND 1 "January 26, 2012"
> +.\" Please adjust this date whenever revising the manpage.
> +.\"
> +.\" Some roff macros, for reference:
> +.\" .nh        disable hyphenation
> +.\" .hy        enable hyphenation
> +.\" .ad l      left justify
> +.\" .ad b      justify to both left and right margins
> +.\" .nf        disable filling
> +.\" .fi        enable filling
> +.\" .br        insert line break
> +.\" .sp<n>     insert n+1 empty lines
> +.\" for manpage-specific macros, see man(7)
> +.SH NAME
> +fwts-frontend-text \- text based interface to fwts.
> +.br
> +
> +.SH SYNOPSIS
> +.B fwts-frontend-text
> +.br
> +
> +.SH DESCRIPTION
> +This manual page briefly documents the
> +.B fwts-frontend-text
> +utility.
> +The tool
> +.B fwts-frontend-text
> +executes a user-friendly interface to the Firmware Test Suite, providing the
> +user a simple interface to execute all batch tests or the ability to select
> +individual tests to execute.
> +.B
> +fwts-frontend-text
> +should be run with root priviledge, for example using sudo.
> +.br
> +.LP
> +Running
> +.B
> +fwts-frontend-text
> +with the argument noautoshutdown will prevent the system
> +from shutting down after tests have been executed.
> +.P
> +.SH EXAMPLES
> +.LP
> +Execute fwts-frontend-text
> +.RS 8
> +sudo fwts-frontend-text
> +.RE
> +.LP
> +Execute fwts-frontend-text and disable automatic shutdown
> +.RS 8
> +sudo fwts-frontend-text noautoshutdown
> +.SH SEE ALSO
> +.BR fwts (1),
> +.BR dmidecode (8),
> +.BR lspci (8)
> +.SH AUTHOR
> +fwts-frontend-text was written by Colin King<colin.king@canonical.com>,
> +and Chris Van Hoof<vanhoof@canonical.com>
> +.PP
> +This manual page was written by Chris Van Hoof<vanhoof@canonical.com>,
> +for the Ubuntu project (but may be used by others).
Acked-by: Colin King <colin.king@canonical.com>

Patch

diff --git a/doc/fwts-frontend-text.1 b/doc/fwts-frontend-text.1
new file mode 100644
index 0000000..14e4a5b
--- /dev/null
+++ b/doc/fwts-frontend-text.1
@@ -0,0 +1,65 @@ 
+.\"                                      Hey, EMACS: -*- nroff -*-
+.\" First parameter, NAME, should be all caps
+.\" Second parameter, SECTION, should be 1-8, maybe w/ subsection
+.\" other parameters are allowed: see man(7), man(1)
+.TH FWTS-FRONTEND 1 "January 26, 2012"
+.\" Please adjust this date whenever revising the manpage.
+.\"
+.\" Some roff macros, for reference:
+.\" .nh        disable hyphenation
+.\" .hy        enable hyphenation
+.\" .ad l      left justify
+.\" .ad b      justify to both left and right margins
+.\" .nf        disable filling
+.\" .fi        enable filling
+.\" .br        insert line break
+.\" .sp <n>    insert n+1 empty lines
+.\" for manpage-specific macros, see man(7)
+.SH NAME
+fwts-frontend-text \- text based interface to fwts.
+.br
+
+.SH SYNOPSIS
+.B fwts-frontend-text
+.br
+
+.SH DESCRIPTION
+This manual page briefly documents the
+.B fwts-frontend-text
+utility.
+The tool
+.B fwts-frontend-text
+executes a user-friendly interface to the Firmware Test Suite, providing the
+user a simple interface to execute all batch tests or the ability to select
+individual tests to execute.
+.B
+fwts-frontend-text
+should be run with root priviledge, for example using sudo.
+.br
+.LP
+Running
+.B
+fwts-frontend-text
+with the argument noautoshutdown will prevent the system
+from shutting down after tests have been executed.
+.P
+.SH EXAMPLES
+.LP
+Execute fwts-frontend-text
+.RS 8
+sudo fwts-frontend-text
+.RE
+.LP
+Execute fwts-frontend-text and disable automatic shutdown
+.RS 8
+sudo fwts-frontend-text noautoshutdown
+.SH SEE ALSO
+.BR fwts (1),
+.BR dmidecode (8),
+.BR lspci (8)
+.SH AUTHOR
+fwts-frontend-text was written by Colin King <colin.king@canonical.com>,
+and Chris Van Hoof <vanhoof@canonical.com>
+.PP
+This manual page was written by Chris Van Hoof <vanhoof@canonical.com>,
+for the Ubuntu project (but may be used by others).