805de1f24a156164f2563cb50728f2ea288489cf
[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
26 import time
27 import datetime
28
29
30 def man_format(data):
31     data = data.replace("-", "\\-")
32     data = data.replace("\t", "    ")
33     # data = data.replace("$", "\\fI")
34
35     data_ls = []
36     for w in data.split():
37         if w.startswith("$"):
38             w = "\\fI" + w[1:] + "\\fR"
39
40         data_ls.append(w)
41
42     data = data[:len(data) - len(data.lstrip())] + " ".join(data_ls)
43
44     return data
45
46
47 blender_bin = os.path.join(os.path.dirname(__file__), "../../blender")
48
49 blender_help = subprocess.Popen([blender_bin, "--help"], stdout=subprocess.PIPE).communicate()[0].decode()
50
51 blender_version = subprocess.Popen([blender_bin, "--version"], stdout=subprocess.PIPE).communicate()[0].decode().strip()
52 blender_version = blender_version.split("Build")[0]
53
54 date_string = datetime.date.fromtimestamp(time.time()).strftime("%B %d, %Y")
55
56 filepath = os.path.splitext(__file__)[0]
57
58 file = open(filepath, "w")
59
60 fw = file.write
61
62 fw('.TH "BLENDER" "1" "%s" "Blender %s"\n' % (date_string, blender_version.replace(".", "\\&.")))
63
64 fw('''
65 .SH NAME
66 blender \- a 3D modelling and rendering package''')
67
68 fw('''
69 .SH SYNOPSIS
70 .B blender [args ...] [file] [args ...]''')
71
72 fw('''
73 .br
74 .SH DESCRIPTION
75 .PP
76 .B blender
77 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.
78
79 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.
80
81 http://www.blender.org''')
82
83 fw('''
84 .SH OPTIONS''')
85
86 fw("\n\n")
87
88 lines = [line.rstrip() for line in blender_help.split("\n")]
89
90 while lines:
91     l = lines.pop(0)
92     if l.startswith("Environment Variables:"):
93         fw('.SH "ENVIRONMENT VARIABLES"\n')
94     elif l.endswith(":"):  # one line
95         fw('.SS "%s"\n\n' % l)
96     elif l.startswith("-") or l.startswith("/"):  # can be multi line
97
98         fw('.TP\n')
99         fw('.B %s\n' % man_format(l))
100
101         while lines:
102             # line with no
103             if lines[0].strip() and len(lines[0].lstrip()) == len(lines[0]):  # no white space
104                 break
105
106             if not l:  # second blank line
107                 fw('.IP\n')
108             else:
109                 fw('.br\n')
110
111             l = lines.pop(0)
112             l = l[1:]  # remove first whitespace (tab)
113
114             fw('%s\n' % man_format(l))
115
116     else:
117         if not l.strip():
118             fw('.br\n')
119         else:
120             fw('%s\n' % man_format(l))
121
122 # footer
123
124 fw('''
125 .br
126 .SH SEE ALSO
127 .B yafaray(1)
128
129 .br
130 .SH AUTHORS
131 This manpage was written for a Debian GNU/Linux system by Daniel Mester
132 <mester@uni-bremen.de> and updated by Cyril Brulebois
133 <cyril.brulebois@enst-bretagne.fr> and Dan Eicher <dan@trollwerks.org>.
134 ''')
135
136 print("written:", filepath)