Package manfile_gen

Functions
def	genorate_man
	genorate_man() -> str
Variables
string	__copyright__
	genorate man file for slimproj
string	__license__
tuple	man_template = Template(""".TH SLIMPROJ 1 "${date}".SH NAMEslimproj \- SLIMpy tool for scons.SH SYNOPSIS${projec_doc}To include slinproj in a SCons file use.ESfrom slimproj import *.EE.B slimprojprovides the following builder methods:'\"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""'\" BEGIN GENERATED BUILDER DESCRIPTIONS'\"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""${BUILDERS}.SS Construction VariablesA number of useful construction variables are automatically defined byscons for each supported platform, and additional construction variablescan be defined by the user. The following is a list of the automaticallydefined construction variables:'\"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""'\" BEGIN GENERATED CONSTRUCTION VARIABLE DESCRIPTIONS'\"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""${VARIABLES}""")
tuple	func_template
tuple	example_tem = Template(""".B Example:.ES${example}.EE""" )
string	authorstr = "\n.B Author:\n%s"
tuple	params_tem = Template("\n\n.B PARAMETERS:\n${params}\n\n")

---

Function Documentation

def manfile_gen.genorate_man

(

)

genorate_man() -> str

Definition at line 88 of file manfile_gen.py.

---

Variable Documentation

string __copyright__

Initial value:

"""
Copyright 2008 Sean Ross-Ross
"""

genorate man file for slimproj

Definition at line 7 of file manfile_gen.py.

string __license__

Initial value:

"""
This file is part of SLIMpy .

SLIMpy is free software: you can redistribute it and/or modify
it under the terms of the GNU Lesser General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.

SLIMpy 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 Lesser General Public License for more details.

You should have received a copy of the GNU Lesser General Public License
along with SLIMpy . If not, see <http://www.gnu.org/licenses/>.
"""

Definition at line 10 of file manfile_gen.py.

string authorstr = "\n.B Author:\n%s"

Definition at line 81 of file manfile_gen.py.

tuple example_tem = Template(""".B Example:.ES${example}.EE""" )

Definition at line 73 of file manfile_gen.py.

tuple func_template

Initial value:

Template(""".IP ${name}().IP env.${name}()${doc}${params}${example}${author}"""
)

Definition at line 64 of file manfile_gen.py.

tuple man_template = Template(""".TH SLIMPROJ 1 "${date}".SH NAMEslimproj \- SLIMpy tool for scons.SH SYNOPSIS${projec_doc}To include slinproj in a SCons file use.ESfrom slimproj import *.EE.B slimprojprovides the following builder methods:'\"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""'\" BEGIN GENERATED BUILDER DESCRIPTIONS'\"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""${BUILDERS}.SS Construction VariablesA number of useful construction variables are automatically defined byscons for each supported platform, and additional construction variablescan be defined by the user. The following is a list of the automaticallydefined construction variables:'\"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""'\" BEGIN GENERATED CONSTRUCTION VARIABLE DESCRIPTIONS'\"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""${VARIABLES}""")

Definition at line 30 of file manfile_gen.py.

tuple params_tem = Template("\n\n.B PARAMETERS:\n${params}\n\n")

Definition at line 82 of file manfile_gen.py.