Merge pull request #225 from MicroJoe/man-page

introduce man page ots-sanitize.1

docs/ots-sanitize.1

@@ -0,0 +1,42 @@
+.TH OTS-SANITIZE "1" "November 2020" "OpenType Sanitizer" "User Commands"
+.SH NAME
+ots-sanitize \- font validator and transcoder
+.SH SYNOPSIS
+.B yes
+[\fI\,OPTIONS\/\fR]... \fI\,FONT_FILE\/\fR [\fI\,DEST_FONT_FILE\/\fR] [\fI\,FONT_INDEX\/\fR]
+.SH DESCRIPTION
+.\" Add any additional description here
+.PP
+ots-sanitize is a program which validates and/or transcodes a font file using
+the OTS library.
+.PP
+The OpenType Sanitizer (OTS) parses and serializes OpenType files (OTF, TTF)
+and WOFF and WOFF2 font files, validating them and sanitizing them as it goes.
+.TP
+\fB\-\-quiet\fR
+do not display information or error messages
+.TP
+\fB\-\-version\fR
+output version information and exit
+.SH EXAMPLES
+Sanitize a sample and save it to another file:
+.PP
+.RS
+.nf
+$ ots-sanitize sample.otf transcoded_sample.otf
+File sanitized successfully!
+.fi
+.RE
+.PP
+Try to sanitize a malformed file:
+.PP
+.RS
+.nf
+$ ots-sanitize malformed.ttf
+WARNING: bad range shift
+ERROR at src/ots.cc:670 (ProcessGeneric)
+Failed to sanitize file!
+.RE
+.fi
+.SH "REPORTING BUGS"
+Report bugs to  <https://github.com/khaledhosny/ots/issues>

meson.build

@@ -303,6 +303,8 @@ if cxx.has_header('sys/time.h')
 endif
 
 
+install_man('docs/ots-sanitize.1')
+
 gtest = subproject('gtest').get_variable('gtest_main_dep')
 
 cff_charstring = executable('cff_charstring',