From patchwork Tue Jun 21 14:49:19 2011 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: alexandros.frantzis@linaro.org X-Patchwork-Id: 2129 Return-Path: X-Original-To: patchwork@peony.canonical.com Delivered-To: patchwork@peony.canonical.com Received: from fiordland.canonical.com (fiordland.canonical.com [91.189.94.145]) by peony.canonical.com (Postfix) with ESMTP id 1B55C23E02 for ; Tue, 21 Jun 2011 14:49:22 +0000 (UTC) Received: from mail-vw0-f52.google.com (mail-vw0-f52.google.com [209.85.212.52]) by fiordland.canonical.com (Postfix) with ESMTP id B155FA18807 for ; Tue, 21 Jun 2011 14:49:21 +0000 (UTC) Received: by vws16 with SMTP id 16so4769170vws.11 for ; Tue, 21 Jun 2011 07:49:21 -0700 (PDT) Received: by 10.52.100.72 with SMTP id ew8mr1927587vdb.247.1308667761091; Tue, 21 Jun 2011 07:49:21 -0700 (PDT) X-Forwarded-To: linaro-patchwork@canonical.com X-Forwarded-For: patch@linaro.org linaro-patchwork@canonical.com Delivered-To: patches@linaro.org Received: by 10.52.183.130 with SMTP id em2cs72867vdc; Tue, 21 Jun 2011 07:49:20 -0700 (PDT) Received: by 10.217.1.5 with SMTP id m5mr6476024wes.19.1308667760060; Tue, 21 Jun 2011 07:49:20 -0700 (PDT) Received: from adelie.canonical.com (adelie.canonical.com [91.189.90.139]) by mx.google.com with ESMTP id f31si15671762wes.85.2011.06.21.07.49.19; Tue, 21 Jun 2011 07:49:20 -0700 (PDT) Received-SPF: pass (google.com: best guess record for domain of bounces@canonical.com designates 91.189.90.139 as permitted sender) client-ip=91.189.90.139; Authentication-Results: mx.google.com; spf=pass (google.com: best guess record for domain of bounces@canonical.com designates 91.189.90.139 as permitted sender) smtp.mail=bounces@canonical.com Received: from loganberry.canonical.com ([91.189.90.37]) by adelie.canonical.com with esmtp (Exim 4.71 #1 (Debian)) id 1QZ2GV-0001IK-CX for ; Tue, 21 Jun 2011 14:49:19 +0000 Received: from loganberry.canonical.com (localhost [127.0.0.1]) by loganberry.canonical.com (Postfix) with ESMTP id 5C6B52E802E for ; Tue, 21 Jun 2011 14:49:19 +0000 (UTC) MIME-Version: 1.0 X-Launchpad-Project: glmark2 X-Launchpad-Branch: ~afrantzis/glmark2/trunk X-Launchpad-Message-Rationale: Subscriber X-Launchpad-Branch-Revision-Number: 87 X-Launchpad-Notification-Type: branch-revision To: Linaro Patch Tracker From: noreply@launchpad.net Subject: [Branch ~afrantzis/glmark2/trunk] Rev 87: Improve man pages. Message-Id: <20110621144919.638.65566.launchpad@loganberry.canonical.com> Date: Tue, 21 Jun 2011 14:49:19 -0000 Reply-To: noreply@launchpad.net Sender: bounces@canonical.com Errors-To: bounces@canonical.com Precedence: bulk X-Generated-By: Launchpad (canonical.com); Revision="13242"; Instance="initZopeless config overlay" X-Launchpad-Hash: 32a589420122cc41e19db013f3b51f2f4c19fc08 ------------------------------------------------------------ revno: 87 committer: Alexandros Frantzis branch nick: trunk timestamp: Tue 2011-06-21 17:46:40 +0300 message: Improve man pages. removed: doc/glmark2-es2.1 doc/glmark2.1 added: doc/glmark2.1.in modified: doc/wscript_build --- lp:glmark2 https://code.launchpad.net/~afrantzis/glmark2/trunk You are subscribed to branch lp:glmark2. To unsubscribe from this branch go to https://code.launchpad.net/~afrantzis/glmark2/trunk/+edit-subscription === removed file 'doc/glmark2-es2.1' --- doc/glmark2-es2.1 2010-07-15 09:59:22 +0000 +++ doc/glmark2-es2.1 1970-01-01 00:00:00 +0000 @@ -1,15 +0,0 @@ -.TH GLMARK2-ES2 1 "2010-07-15" -.SH NAME -glmark2(-es2) \- OpenGL (ES) 2.0 benchmark -.SH SYNOPSIS -.B glmark2 -.br -.B glmark2-es2 -.SH DESCRIPTION -\fBglmark2(-es2)\fP is a benchmark for OpenGL (ES) 2.0. It only uses the subset of -the OpenGL 2.0 API that is compatible with OpenGL ES 2.0. -.SH AUTHOR -glmark2 was written by Alexandros Frantzis based on the original glmark by Ben Smith. -.PP -This manual page was written by Alexandros Frantzis , -for the Debian project (and may be used by others). === removed file 'doc/glmark2.1' --- doc/glmark2.1 2010-07-15 09:59:22 +0000 +++ doc/glmark2.1 1970-01-01 00:00:00 +0000 @@ -1,15 +0,0 @@ -.TH GLMARK2 1 "2010-07-15" -.SH NAME -glmark2(-es2) \- OpenGL (ES) 2.0 benchmark -.SH SYNOPSIS -.B glmark2 -.br -.B glmark2-es2 -.SH DESCRIPTION -\fBglmark2(-es2)\fP is a benchmark for OpenGL (ES) 2.0. It only uses the subset of -the OpenGL 2.0 API that is compatible with OpenGL ES 2.0. -.SH AUTHOR -glmark2 was written by Alexandros Frantzis based on the original glmark by Ben Smith. -.PP -This manual page was written by Alexandros Frantzis , -for the Debian project (and may be used by others). === added file 'doc/glmark2.1.in' --- doc/glmark2.1.in 1970-01-01 00:00:00 +0000 +++ doc/glmark2.1.in 2011-06-21 14:46:40 +0000 @@ -0,0 +1,70 @@ +.TH @APPNAME@ "1" "June 2011" "@appname@ 11.06" +.SH NAME +@appname@ \- OpenGL (ES) 2.0 benchmark suite +.SH SYNOPSIS +.B @appname@ [options] +.SH DESCRIPTION +\fB@appname@\fP is a benchmark for OpenGL (ES) 2.0. It only uses the subset of +the OpenGL 2.0 API that is compatible with OpenGL ES 2.0. +.SH OPTIONS +.TP +\fB\-b\fR, \fB\-\-benchmark\fR BENCH +A benchmark to run: 'scene(:opt1=val1)*' +(the option can be used multiple times) +.TP +\fB\-\-validate\fR +Run a quick output validation test instead of +running the benchmarks +.TP +\fB\-\-no\-swap\-buffers\fR +Don't update the screen by swapping the front and +back buffer, use glFinish() instead +.TP +\fB\-l\fR, \fB\-\-list\-scenes\fR +Display information about the available scenes +and their options +.TP +\fB\-d\fR, \fB\-\-debug\fR +Display debug messages +.TP +\fB\-h\fR, \fB\-\-help\fR +Display help +.SH BENCHMARKS +@appname@ offers a suite of scenes that can be used to measure many aspects +of OpenGL (ES) 2.0 performance. The way in which each scene is rendered is +configurable through a set of options. To get the available scenes and their +acceptable options you can use the \fB\-l\fR, \fB\-\-list\-scenes\fR command +line option. + +In @appname@, a benchmark is defined as a scene plus a set of option values. +You can specify the list and order of the benchmarks to run by using the +\fB\-b\fR, \fB\-\-benchmark\fR command line option (possibly multiple times). +If no benchmarks are specified, a default set of benchmarks is used. If a +benchmark option is not specified it assumes its default value (listed with +\fB\-l\fR, \fB\-\-list\-scenes\fR). + +.SH EXAMPLES +To run the default benchmarks: +.PP +.RS +\fB@appname@\fR +.RE +.PP +To run a benchmark using scene 'shading' with a 'duration' of '5.0' seconds and + 'shading' of type 'phong': +.PP +.RS +\fB@appname@ -b shading:duration=5.0:shading=phong\fR +.RE +.PP +To run a series of benchmarks use the \fB\-b\fR, \fB\-\-benchmark\fR command +line option multiple times: +.PP +.RS +\fB@appname@ -b shading:duration=5.0 -b build:use-vbo=false -b texture\fR +.RE +.PP + +.SH AUTHOR +@appname@ was written by Alexandros Frantzis based on the original glmark by +Ben Smith. === modified file 'doc/wscript_build' --- doc/wscript_build 2011-01-25 00:59:11 +0000 +++ doc/wscript_build 2011-06-21 14:46:40 +0000 @@ -1,7 +1,19 @@ if bld.env.USE_GL: - bld.install_files('${PREFIX}/share/man/man1', - bld.path.ant_glob('glmark2.1')) + bld( + features = 'subst', + source = 'glmark2.1.in', + target = bld.path.find_or_declare('glmark2.1'), + APPNAME = 'GLMARK2', + appname = 'glmark2', + install_path = '${PREFIX}/share/man/man1' + ) if bld.env.USE_GLESv2: - bld.install_files('${PREFIX}/share/man/man1', - bld.path.ant_glob('glmark2-es2.1')) + bld( + features = 'subst', + source = 'glmark2.1.in', + target = bld.path.find_or_declare('glmark2-es2.1'), + APPNAME = 'GLMARK2-ES2', + appname = 'glmark2-es2', + install_path = '${PREFIX}/share/man/man1' + )