Fixed bug introduced while adding feature
[schreib.git] / schreib.1
1 .TH SCHREIB 1 schreib\-VERSION
2 .SH NAME
3 schreib \- multilingual website system
4 .SH SYNOPSIS
5 .B schreib \fR[ -d \fIDIR\fR ] [ -q | -v ] \fB{b,i,d,a}\fR
6 .SH DESCRIPTION
7 Schreibblockade is a website management system that allows easy
8 management of multilingual sites. In schreibblockade, the text for
9 different translations of the same page are kept in the same file,
10 allowing common sections.
11 .P
12 Schreibblockade is based on poole, written by Oben Sonne
13 .SH COMMANDS
14 .TP
15 .B build, b \fR[-m \fIEXT\fR] [-b \fIURL\fR]
16 Builds the website
17 .TP
18 .B init, i
19 Initializes a new website with example content.
20 .TP
21 .B deploy, d \fR[-m \fIEXT\fR] [-b \fIURL\fR]
22 Deploys the website. Runs
23 .BR ./schreibdeploy.sh
24 if it exists to deploy the website on the server.
25 .TP
26 .B add, a \fIPATH\fR
27 Adds a new page.
28 .B PATH
29 is relative to the project root directory (see
30 .B \-d
31 ). Runs your
32 .BR $EDITOR
33 to edit it.
34 .SH OPTIONS
35 .TP
36 .B \-m \fIEXT
37 Adds extensions EXT to the markdown converter
38 .TP
39 .B \-b \fIURL
40 Base url for relative links (Default: /)
41 .TP
42 .B \-d \fIDIR
43 Set the base directory for the website. Default: when building, descend from the current directory until a project directory is found.
44 .TP
45 .B \-q
46 Supress all output
47 .TP
48 .B \-v
49 Add informational output (May flood your terminal).
50 .TP
51 .B \-\-no-start-editor
52 For the \fBadd\fR command, do not start $\fBEDITOR.\fR
53
54 .SH FILES
55 .TP
56 .B ./macros.py
57 This file stores macros that can be accessed from the pages.
58 .TP
59 .B ./schreibdeploy.sh
60 This script is run when deploying the website.
61 .TP
62 .B ./page.html
63 The template for your website.
64 .SH ERROR CODES
65 .TP
66 .B 1
67 Syntax error
68 .TP
69 .B 12
70 Could not find project directory.
71 .TP
72 .B 13
73 Could not find deploy script.
74 .TP
75 .B 20
76 Python error
77 .TP
78 .B 30
79 Initialization error: Directory not empty.
80 .TP
81 .B 112
82 Other errors.
83
84
85 .SH TIPS
86 It is advised to use a versioning system to track changes to the website.
87 .SH SEE ALSO
88 .BR git (1)
89 .SH AUTHORS
90 Gabriel Pérez-Cerezo wrote this manpage in 2016