hachem.wtf
aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorhachem <im@hachem.wtf>2026-09-19 16:19:29 +0200
committerhachem <im@hachem.wtf>2026-09-19 16:19:29 +0200
commitb37d3e2a949f2a94d71aa531e8e55198dee7d8e9 (patch)
treeb29e75fe679ef1ac572daf7122c2de391c1efc77
parent3131b944331278534e299361c7619e4fe3e43cd4 (diff)
docs: update man pageHEADmain
-rw-r--r--mktypst.196
1 files changed, 89 insertions, 7 deletions
diff --git a/mktypst.1 b/mktypst.1
index 66b9722..27d12fe 100644
--- a/mktypst.1
+++ b/mktypst.1
@@ -66,16 +66,98 @@ Print version and exit.
.BR \-h ", " \-\-help
Print a usage summary and exit.
.SH TEMPLATES
-.TP
-.B paper
+Apply a template with a
+.B #show
+rule and set any of these named fields; every field is optional, and the
+document body is whatever follows the rule. Both templates are French by
+default \(em pass
+.B "lang: \(dqen\(dq"
+for English.
+.SS paper
A two-column academic article.
.TP
-.B letter
+.B title
+Document title, centered at the top. Default: none.
+.TP
+.B date
+Date line under the title, a string such as
+.BR \(dqmars\ 2026\(dq .
+Default: none.
+.TP
+.B authors
+Array of author dictionaries, each
+(name: \(dq...\(dq, location: [...]). Default: empty.
+.TP
+.B abstract
+Abstract paragraph, shown before the first heading. Default: none.
+.TP
+.B lang
+Text language, e.g.\&
+.BR \(dqfr\(dq " or " \(dqen\(dq .
+Default:
+.BR \(dqfr\(dq .
+.TP
+.B region
+Text region. Default:
+.BR \(dqFR\(dq .
+.TP
+.B font
+Body font. Default:
+.BR \(dqEB\ Garamond\(dq .
+.TP
+.B size
+Body text size. Default:
+.BR 10pt .
+.SS letter
A French formal letter.
-.PP
-Both are French by default; pass
-.B "lang: \(dqen\(dq"
-to the template for English.
+.TP
+.B sender
+Your letterhead, a dictionary
+(name: [...], address: [...]). Default: none.
+.TP
+.B recipient
+The addressee, same shape as
+.BR sender .
+Default: none.
+.TP
+.B place
+Place in the dateline (\(lqParis, le ...\(rq). Default: none.
+.TP
+.B date
+Date in the dateline. Default: none.
+.TP
+.B subject
+The
+.B "Objet :"
+line. Default: none.
+.TP
+.B opening
+Salutation. Default:
+.BR "Madame, Monsieur," .
+.TP
+.B closing
+Closing formula. Default:
+Veuillez agr\('eer, Madame, Monsieur, l\(cqexpression de mes salutations
+distingu\('ees.
+.TP
+.B signature
+Signature line, small caps. Defaults to the sender's name.
+.TP
+.B lang
+Text language. Default:
+.BR \(dqfr\(dq .
+.TP
+.B region
+Text region. Default:
+.BR \(dqFR\(dq .
+.TP
+.B font
+Body font. Default:
+.BR \(dqEB\ Garamond\(dq .
+.TP
+.B size
+Body text size. Default:
+.BR 11pt .
.SH ENVIRONMENT
.TP
.B LC_TIME