And here is the first git (testing) commit by me!
[blender.git] / doc / manpage / blender.1.py
1 #!/usr/bin/python
2
3 # ##### BEGIN GPL LICENSE BLOCK #####
4 #
5 #  This program is free software; you can redistribute it and/or
6 #  modify it under the terms of the GNU General Public License
7 #  as published by the Free Software Foundation; either version 2
8 #  of the License, or (at your option) any later version.
9 #
10 #  This program is distributed in the hope that it will be useful,
11 #  but WITHOUT ANY WARRANTY; without even the implied warranty of
12 #  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
13 #  GNU General Public License for more details.
14 #
15 #  You should have received a copy of the GNU General Public License
16 #  along with this program; if not, write to the Free Software Foundation,
17 #  Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
18 #
19 # ##### END GPL LICENSE BLOCK #####
20
21 # <pep8 compliant>
22
23 import subprocess
24 import os
25 import sys
26
27 import time
28 import datetime
29
30
31 def man_format(data):
32     data = data.replace("-", "\\-")
33     data = data.replace("\t", "  ")
34     return data
35
36 # allow passing blender as argument
37 if sys.argv[-1].endswith(os.sep + "blender"):
38     blender_bin = sys.argv[-1]
39 else:
40     blender_bin = os.path.join(os.path.dirname(__file__), "../../blender.bin")
41
42 cmd = [blender_bin, "--help"]
43 print("  executing:", " ".join(cmd))
44 blender_help = subprocess.Popen(cmd, stdout=subprocess.PIPE).communicate()[0].decode(encoding="utf-8")
45
46 blender_version = subprocess.Popen([blender_bin, "--version"], stdout=subprocess.PIPE).communicate()[0].decode(encoding="utf-8").strip()
47 blender_version = blender_version.split("Build")[0]
48
49 date_string = datetime.date.fromtimestamp(time.time()).strftime("%B %d, %Y")
50
51 filepath = os.path.splitext(__file__)[0]
52
53 file = open(filepath, "w")
54
55 fw = file.write
56
57 fw('.TH "BLENDER" "1" "%s" "Blender %s"\n' % (date_string, blender_version.replace(".", "\\&.")))
58
59 fw('''
60 .SH NAME
61 blender \- a 3D modelling and rendering package''')
62
63 fw('''
64 .SH SYNOPSIS
65 .B blender [args ...] [file] [args ...]''')
66
67 fw('''
68 .br
69 .SH DESCRIPTION
70 .PP
71 .B blender
72 is a 3D modelling and rendering package. It is the in-house software of a high quality animation studio, Blender has proven to be an extremely fast and versatile design instrument. The software has a personal touch, offering a unique approach to the world of Three Dimensions.
73
74 Use Blender to create TV commercials, to make technical visualizations, business graphics, to do some morphing, or design user interfaces. You can easy build and manage complex environments. The renderer is versatile and extremely fast. All basic animation principles (curves & keys) are well implemented.
75
76 http://www.blender.org''')
77
78 fw('''
79 .SH OPTIONS''')
80
81 fw("\n\n")
82
83 lines = [line.rstrip() for line in blender_help.split("\n")]
84
85 while lines:
86     l = lines.pop(0)
87     if l.startswith("Environment Variables:"):
88         fw('.SH "ENVIRONMENT VARIABLES"\n')
89     elif l.endswith(":"):  # one line
90         fw('.SS "%s"\n\n' % l)
91     elif l.startswith("-") or l.startswith("/"):  # can be multi line
92
93         fw('.TP\n')
94         fw('.B %s\n' % man_format(l))
95
96         while lines:
97             # line with no
98             if lines[0].strip() and len(lines[0].lstrip()) == len(lines[0]):  # no white space
99                 break
100
101             if not l:  # second blank line
102                 fw('.IP\n')
103             else:
104                 fw('.br\n')
105
106             l = lines.pop(0)
107             l = l[1:]  # remove first whitespace (tab)
108
109             fw('%s\n' % man_format(l))
110
111     else:
112         if not l.strip():
113             fw('.br\n')
114         else:
115             fw('%s\n' % man_format(l))
116
117 # footer
118
119 fw('''
120 .br
121 .SH SEE ALSO
122 .B yafaray(1)
123
124 .br
125 .SH AUTHORS
126 This manpage was written for a Debian GNU/Linux system by Daniel Mester
127 <mester@uni-bremen.de> and updated by Cyril Brulebois
128 <cyril.brulebois@enst-bretagne.fr> and Dan Eicher <dan@trollwerks.org>.
129 ''')
130
131 print("written:", filepath)