From 23099379fb0d9a1ae0194c3b4fe64e0414b94749 Mon Sep 17 00:00:00 2001 From: Lars Wirzenius Date: Sat, 13 Oct 2012 09:03:27 +0100 Subject: Add manual page for obnam-viewprof --- obnam-viewprof.1 | 44 ++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 44 insertions(+) create mode 100644 obnam-viewprof.1 (limited to 'obnam-viewprof.1') diff --git a/obnam-viewprof.1 b/obnam-viewprof.1 new file mode 100644 index 00000000..b744ad11 --- /dev/null +++ b/obnam-viewprof.1 @@ -0,0 +1,44 @@ +.\" Copyright 2012 Lars Wirzenius +.\" +.\" This program is free software: you can redistribute it and/or modify +.\" it under the terms of the GNU General Public License as published by +.\" the Free Software Foundation, either version 3 of the License, or +.\" (at your option) any later version. +.\" +.\" This program is distributed in the hope that it will be useful, +.\" but WITHOUT ANY WARRANTY; without even the implied warranty of +.\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +.\" GNU General Public License for more details. +.\" +.\" You should have received a copy of the GNU General Public License +.\" along with this program. If not, see . +.\" +.TH OBNAM-VIEWPROF 1 +.SH NAME +obnam-viewprof \- show Python profiler output +.SH SYNOPSIS +.B obnam-viewprof +.I profile +.RI [ sort-order ] +.SH DESCRIPTION +.B obnam-viewprof +shows a plain text version of Python profiler output. +You can generate such output from Obnam by setting the +.B OBNAM_PROFILE +environment variable to a filename. +The profile will be written to that filename, +and you should give it to +.B obnam-viewprof +as an argument. +.PP +The +.I sort-order +argument defaults to +.B cumulative +and can be any of the orderings that the Python pstats library supports. +.PP +.B obnam-viewprof +is mainly useful for those developing +.BR obnam (1). +.SH "SEE ALSO" +.BR obnam (1). -- cgit v1.2.1