root / pkpgcounter / trunk / bin / pkpgcounter @ 549

Revision 549, 3.6 kB (checked in by jerome, 16 years ago)

Updated documentation.

  • Property svn:executable set to *
  • Property svn:keywords set to Auth Date Id Rev
RevLine 
[185]1#! /usr/bin/env python
2# -*- coding: ISO-8859-15 -*-
3#
4# pkpgcounter : a generic Page Description Language parser
5#
[443]6# (c) 2003, 2004, 2005, 2006, 2007 Jerome Alet <alet@librelogiciel.com>
[463]7# This program is free software: you can redistribute it and/or modify
[185]8# it under the terms of the GNU General Public License as published by
[463]9# the Free Software Foundation, either version 3 of the License, or
[185]10# (at your option) any later version.
[463]11#
[185]12# This program is distributed in the hope that it will be useful,
13# but WITHOUT ANY WARRANTY; without even the implied warranty of
14# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
15# GNU General Public License for more details.
16#
17# You should have received a copy of the GNU General Public License
[463]18# along with this program.  If not, see <http://www.gnu.org/licenses/>.
[185]19#
20# $Id$
21#
22#
23
[211]24import sys
[235]25from pkpgpdls.version import __version__, __author__, __authoremail__, \
[223]26                                __years__, __gplblurb__
[235]27from pkpgpdls import analyzer
[186]28
[223]29__doc__ = """pkpgcounter v%(__version__)s (c) %(__years__)s %(__author__)s
30
31pkpgcounter is a generic Page Description Language parser.
32
33pkpgcounter parses any number of input files and/or its standard input
34and outputs the number of pages needed to print these documents.
35
[369]36pkpgcounter can also compute the percent of ink coverage in different
37colorspaces for several file formats.
[223]38
[375]39pkpgcounter currently recognizes the following document formats :
[369]40
[223]41    * PostScript (both DSC compliant and binary)
[528]42    * PDF
[223]43    * PCLXL (aka PCL6)
[528]44    * PCL3/4/5
[223]45    * DVI
[528]46    * OpenDocument (ISO/IEC DIS 26300)
[529]47    * Microsoft Word (c) (tm) (r) (etc...)
[418]48    * Plain text
[223]49    * TIFF
[502]50    * Several other image formats
[223]51    * ESC/P2
[329]52    * Zenographics ZjStream
[386]53    * Samsung QPDL (aka SPL2)
[418]54    * Samsung SPL1
[476]55    * ESC/PageS03
[480]56    * Brother HBP
[485]57    * Hewlett-Packard LIDIL (hpijs)
[539]58    * Structured Fax
[545]59    * Canon BJ/BJC
[549]60    * ASCII PNM (Netpbm)
[223]61
[549]62The ten latter ones, as well as some TIFF documents, are currently
[528]63only supported in page counting mode.
[369]64
[223]65command line usage :
66
67  pkpgcounter [options] [files]
68
69options :
70
[369]71  -v | --version        Prints pkpgcounter's version number then exits.
72  -h | --help           Prints this message then exits.
[223]73 
[369]74  -d | --debug          Activate debug mode.
[223]75 
[369]76  -cCOLORSPACE, --colorspace=COLORSPACE
77                        Activate the computation of ink usage, and defines the
[439]78                        colorspace to use. Supported values are 'BW' (Black),
79                        'RGB', 'CMYK', 'CMY', and 'GC' (Grayscale vs Color).
80                        'GC' is useful if you only need to differentiate
81                        grayscale pages from coloured pages but don't care
82                        about ink usage per se.
[369]83                       
84  -rRESOLUTION, --resolution=RESOLUTION
85                        The resolution in DPI to use when checking ink usage.
86                        Lower resolution is faster but less accurate. Default
87                        is 72 dpi.
88 
[223]89examples :                             
90
91  $ pkpgcounter file1.ps file2.escp2 file3.pclxl <file4.pcl345
92 
93  Will launch pkpgcounter and will output the total number of pages
94  needed to print all the documents specified.
95 
[369]96  $ pkpgcounter --colorspace bw --resolution 150 file1.ps
97 
98  Will output the percent of black ink needed on each page of
[374]99  the file1.ps file rendered at 150 dpi.
[369]100 
[223]101%(__gplblurb__)s 
102
103Please e-mail bugs to: %(__authoremail__)s"""
104
[199]105if __name__ == "__main__" : 
[211]106    if (len(sys.argv) >= 2) and (sys.argv[1] in ("-h", "--help")) :
[223]107        print __doc__ % globals()
[211]108    else :   
109        analyzer.main()
Note: See TracBrowser for help on using the browser.