.\" DO NOT MODIFY THIS FILE!  It was generated by help2man 1.47.6.
.TH ZIMWRITERFS "1" "June 2018" "OpenZIM" "User Commands"
.SH NAME
zimwriterfs - creates ZIM files from a locally-stored directory
.SH SYNOPSIS
.B zimwriterfs
[\fI\,mandatory arguments\/\fR] [\fI\,optional arguments\/\fR] \fI\,HTML_DIRECTORY ZIM_FILE\/\fR
.SH DESCRIPTION
.SS "Mandatory arguments:"
.TP
\fB\-w\fR, \fB\-\-welcome\fR
path of default/main HTML page. The path must be relative to HTML_DIRECTORY.
.TP
\fB\-f\fR, \fB\-\-favicon\fR
path of ZIM file favicon. The path must be relative to HTML_DIRECTORY and the image a 48x48 PNG.
.TP
\fB\-l\fR, \fB\-\-language\fR
language code of the content in ISO639\-3
.TP
\fB\-t\fR, \fB\-\-title\fR
title of the ZIM file
.TP
\fB\-d\fR, \fB\-\-description\fR
short description of the content
.TP
\fB\-c\fR, \fB\-\-creator\fR
creator(s) of the content
.TP
\fB\-p\fR, \fB\-\-publisher\fR
creator of the ZIM file itself
.TP
HTML_DIRECTORY
is the path of the directory containing the HTML pages you want to put in the ZIM file,
.TP
ZIM_FILE
is the path of the ZIM file you want to obtain.
.SS "Optional arguments:"
.TP
\fB\-v\fR, \fB\-\-verbose\fR
print processing details on STDOUT
.TP
\fB\-h\fR, \fB\-\-help\fR
print this help
.TP
\fB\-m\fR, \fB\-\-minChunkSize\fR
number of bytes per ZIM cluster (default: 2048)
.TP
\fB\-x\fR, \fB\-\-inflateHtml\fR
try to inflate HTML files before packing (*.html, *.htm, ...)
.TP
\fB\-u\fR, \fB\-\-uniqueNamespace\fR
put everything in the same namespace 'A'. Might be necessary to avoid problems with dynamic/javascript data loading.
.TP
\fB\-r\fR, \fB\-\-redirects\fR
path to the TSV file with the list of redirects (url, title, target_url tab separated).
.HP
\fB\-i\fR, \fB\-\-withFullTextIndex\fR index the content and add it to the ZIM.
.TP
\fB\-a\fR, \fB\-\-tags\fR
tags \- semicolon separated
.TP
\fB\-n\fR, \fB\-\-name\fR
custom (version independent) identifier for the content
.SH EXAMPLE
.TP
zimwriterfs \fB\-\-welcome\fR=\fI\,index\/\fR.html \fB\-\-favicon\fR=\fI\,m\/\fR/favicon.png \fB\-\-language\fR=\fI\,fra\/\fR \fB\-\-title\fR=\fI\,foobar\/\fR \fB\-\-description\fR=\fI\,mydescription\/\fR \fB\-\-creator\fR=\fI\,Wikipedia\fR \fB\-\-publisher\fR=\fI\,Kiwix\/\fR ./my_project_html_directory my_project.zim
.SH REPORTING BUGS
.TP
Report bugs to <https://github.com/openzim/zimwriterfs>.