← Back to branch summary

~ibid-core/ibid/trunk

« back to all changes in this revision

Viewing changes to docs/manpages/ibid-memgraph.1.rst

  • Committer: Tarmac
  • Author(s): Stefano Rivera
  • Date: 2012-07-31 09:51:02 UTC
  • mfrom: (1043.2.4 sphinxdoc-man)
  • Revision ID: tarmac-20120731095102-ok97by9518vw2bum
Move manpages into Sphinx docs
Author: Stefano Rivera
Merge Request: http://code.launchpad.net/~stefanor/ibid/sphinxdoc-man/+merge/88115
Approved by: Keegan Carruthers-Smith, Jonathan Hitchcock
Fixes LP: #

Show diffs side-by-side

added added

removed removed

Lines of Context:
docs/manpages/ibid-memgraph.1.rst
1
 
% IBID-MEMGRAPH(1) Ibid Multi-protocol Bot | Ibid 0.1
2
 
% Stefano Rivera
3
 
% March 2010
4
 
 
5
 
# NAME
6
 
 
7
 
ibid-memgraph - Memory usage graph generation utility for Ibid
8
 
 
9
 
# SYNOPSIS
10
 
 
11
 
**ibid-memgraph** [*options*...] *logfile*  
12
 
**ibid-memgraph** **-h**
13
 
 
14
 
# DESCRIPTION
 
1
===============
 
2
 ibid-memgraph
 
3
===============
 
4
 
 
5
SYNOPSIS
 
6
========
 
7
 
 
8
| ``ibid-memgraph`` [*options*...] *logfile*
 
9
| ``ibid-memgraph`` ``-h``
 
10
 
 
11
DESCRIPTION
 
12
===========
15
13
 
16
14
This utility is for graphing memory usage from an Ibid bot configured to
17
15
log such usage.
18
16
 
19
17
Matplotlib is required for graphing.
20
18
 
21
 
# OPTIONS
22
 
 
23
 
**-o** *FILE*, **-\-output**=*FILE*
24
 
:       Output to *FILE* instead of displaying interactive graph GUI.
25
 
        *FILE* can be any format supported by Matplotlib, detected by the file
26
 
        extension.
27
 
 
28
 
**-d** *DPI*, **-\-dpi**=*DPI*
29
 
        When outputting in raster formats, use *DPI* output DPI.
30
 
 
31
 
**-h**, **-\-help**
32
 
        Show a help message and exit.
33
 
 
34
 
# FILES
35
 
 
36
 
*logfile*
37
 
:       A log file generated by loading the **memory** plugin into Ibid, which will
38
 
        periodically log memory usage.
39
 
        It can be gzip compressed, if the filename ends in **.gz**.
40
 
 
41
 
# SEE ALSO
42
 
`ibid` (1),
43
 
`ibid-objgraph` (1),
 
19
OPTIONS
 
20
=======
 
21
 
 
22
-o FILE, --output=FILE
 
23
   Output to *FILE* instead of displaying interactive graph GUI.
 
24
   *FILE* can be any format supported by Matplotlib, detected by the
 
25
   file extension.
 
26
 
 
27
-d DPI, --dpi=DPI
 
28
   When outputting in raster formats, use *DPI* output DPI.
 
29
 
 
30
-h, --help
 
31
   Show a help message and exit.
 
32
 
 
33
FILES
 
34
=====
 
35
 
 
36
logfile
 
37
   A log file generated by loading the **memory** plugin into Ibid,
 
38
   which will periodically log memory usage.
 
39
   It can be gzip compressed, if the filename ends in ``.gz``.
 
40
 
 
41
SEE ALSO
 
42
========
 
43
 
 
44
``ibid``\ (1),
 
45
``ibid-objgraph``\ (1),
44
46
http://ibid.omnia.za.net/
 
47
 
 
48
.. vi: set et sta sw=3 ts=3: