From patchwork Sat Jan 28 20:39:17 2012 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Chris Van Hoof X-Patchwork-Id: 138411 Return-Path: X-Original-To: incoming@patchwork.ozlabs.org Delivered-To: patchwork-incoming@bilbo.ozlabs.org Received: from chlorine.canonical.com (chlorine.canonical.com [91.189.94.204]) by ozlabs.org (Postfix) with ESMTP id 86B4FB6F67 for ; Sun, 29 Jan 2012 07:39:53 +1100 (EST) Received: from localhost ([127.0.0.1] helo=chlorine.canonical.com) by chlorine.canonical.com with esmtp (Exim 4.71) (envelope-from ) id 1RrF3w-0002Nm-0g for incoming@patchwork.ozlabs.org; Sat, 28 Jan 2012 20:39:52 +0000 Received: from cdptpa-omtalb.mail.rr.com ([75.180.132.120]) by chlorine.canonical.com with esmtp (Exim 4.71) (envelope-from ) id 1RrF3t-0002NR-Bi for fwts-devel@lists.ubuntu.com; Sat, 28 Jan 2012 20:39:49 +0000 X-Authority-Analysis: v=2.0 cv=adPjbGUt c=1 sm=0 a=jrUOvm/RFT1SBfzjC7VLzg==:17 a=vx2EF7sAduUA:10 a=1XB9yynOT10A:10 a=DfNHnWVPAAAA:8 a=_z3vYIlnVoLKt3PVTqgA:9 a=lBRciGGoxdUA:10 a=jrUOvm/RFT1SBfzjC7VLzg==:117 X-Cloudmark-Score: 0 X-Originating-IP: 174.109.107.185 Received: from [174.109.107.185] ([174.109.107.185:20343] helo=haddonfield.itb.ouwish.com) by cdptpa-oedge02.mail.rr.com (envelope-from ) (ecelerity 2.2.3.46 r()) with ESMTP id 2C/F5-15128-41D542F4; Sat, 28 Jan 2012 20:39:48 +0000 Received: from haddonfield.itb.ouwish.com (localhost [127.0.0.1]) by haddonfield.itb.ouwish.com (8.14.4/8.14.4/Debian-2ubuntu2) with ESMTP id q0SKdNKW024337; Sat, 28 Jan 2012 15:39:23 -0500 Received: (from vanhoof@localhost) by haddonfield.itb.ouwish.com (8.14.4/8.14.4/Submit) id q0SKdNsa024336; Sat, 28 Jan 2012 15:39:23 -0500 From: Chris Van Hoof To: fwts-devel@lists.ubuntu.com Subject: [PATCH 2/3] doc: addition of fwts-frontend-text man page Date: Sat, 28 Jan 2012 15:39:17 -0500 Message-Id: <1327783158-24282-2-git-send-email-vanhoof@canonical.com> X-Mailer: git-send-email 1.7.8.3 In-Reply-To: <1327783158-24282-1-git-send-email-vanhoof@canonical.com> References: <1327783158-24282-1-git-send-email-vanhoof@canonical.com> X-BeenThere: fwts-devel@lists.ubuntu.com X-Mailman-Version: 2.1.13 Precedence: list List-Id: Firmware Test Suite Development List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , MIME-Version: 1.0 Sender: fwts-devel-bounces@lists.ubuntu.com Errors-To: fwts-devel-bounces@lists.ubuntu.com Signed-off-by: Chris Van Hoof Acked-by: Keng-Yu Lin Acked-by: Colin King --- 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 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 , +and Chris Van Hoof +.PP +This manual page was written by Chris Van Hoof , +for the Ubuntu project (but may be used by others).