cleanup: shebang lines
[blender.git] / doc / manpage / blender.1.py
1 #!/usr/bin/env 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 '''
22 This script generates the blender.1 man page, embedding the help text
23 from the Blender executable itself. Invoke it as follows:
24
25     blender.1.py <path-to-blender> <output-filename>
26
27 where <path-to-blender> is the path to the Blender executable,
28 and <output-filename> is where to write the generated man page.
29 '''
30
31 # <pep8 compliant>
32
33 import subprocess
34 import sys
35
36 import time
37 import datetime
38
39
40 def man_format(data):
41     data = data.replace("-", "\\-")
42     data = data.replace("\t", "  ")
43     return data
44
45 if len(sys.argv) != 3:
46     import getopt
47     raise getopt.GetoptError("Usage: %s <path-to-blender> <output-filename>" % sys.argv[0])
48
49 blender_bin = sys.argv[1]
50 outfilename = sys.argv[2]
51
52 cmd = [blender_bin, "--help"]
53 print("  executing:", " ".join(cmd))
54 blender_help = subprocess.check_output(cmd).decode(encoding="utf-8")
55 blender_version = subprocess.check_output([blender_bin, "--version"]).decode(encoding="utf-8").strip()
56 blender_version = blender_version.split("build")[0].rstrip()
57 blender_version = blender_version.partition(" ")[2]  # remove 'Blender' prefix.
58 date_string = datetime.date.fromtimestamp(time.time()).strftime("%B %d, %Y")
59
60 outfile = open(outfilename, "w")
61 fw = outfile.write
62
63 fw('.TH "BLENDER" "1" "%s" "Blender %s"\n' % (date_string, blender_version.replace(".", "\\&.")))
64
65 fw('''
66 .SH NAME
67 blender \- a 3D modelling and rendering package''')
68
69 fw('''
70 .SH SYNOPSIS
71 .B blender [args ...] [file] [args ...]''')
72
73 fw('''
74 .br
75 .SH DESCRIPTION
76 .PP
77 .B blender
78 is a 3D modelling and rendering package. Originating as 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.
79
80 Use Blender to create TV commercials, to make technical visualizations, business graphics, to create content for games, 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.
81
82 http://www.blender.org''')
83
84 fw('''
85 .SH OPTIONS''')
86
87 fw("\n\n")
88
89 lines = [line.rstrip() for line in blender_help.split("\n")]
90
91 while lines:
92     l = lines.pop(0)
93     if l.startswith("Environment Variables:"):
94         fw('.SH "ENVIRONMENT VARIABLES"\n')
95     elif l.endswith(":"):  # one line
96         fw('.SS "%s"\n\n' % l)
97     elif l.startswith("-") or l.startswith("/"):  # can be multi line
98
99         fw('.TP\n')
100         fw('.B %s\n' % man_format(l))
101
102         while lines:
103             # line with no
104             if lines[0].strip() and len(lines[0].lstrip()) == len(lines[0]):  # no white space
105                 break
106
107             if not l:  # second blank line
108                 fw('.IP\n')
109             else:
110                 fw('.br\n')
111
112             l = lines.pop(0)
113             l = l[1:]  # remove first whitespace (tab)
114
115             fw('%s\n' % man_format(l))
116
117     else:
118         if not l.strip():
119             fw('.br\n')
120         else:
121             fw('%s\n' % man_format(l))
122
123 # footer
124
125 fw('''
126 .br
127 .SH SEE ALSO
128 .B luxrender(1)
129
130 .br
131 .SH AUTHORS
132 This manpage was written for a Debian GNU/Linux system by Daniel Mester
133 <mester@uni-bremen.de> and updated by Cyril Brulebois
134 <cyril.brulebois@enst-bretagne.fr> and Dan Eicher <dan@trollwerks.org>.
135 ''')
136
137 outfile.close()
138 print("written:", outfilename)