KIWIX(1)                    General Commands Manual                   KIWIX(1)



<?><?><?> (NAME)
       kiwix-serve - <?><?><?><?> HTTP <?><?><?><?> <?><?><?><?>
       <?><?><?><?><?><?><?><?><?> <?><?><?><?><?><?><?><?> ZIM
       <?><?><?><?><?><?><?><?><?> Kiwix


<?><?><?><?><?> <?><?><?><?><?> (SYNOPSIS)
       kiwix-serve --library [<?><?><?><?><?><?><?><?>] LIBRARY_FILE_PATH
       kiwix-serve [<?><?><?><?><?><?><?><?>] ZIM_FILE_PATH ...


<?><?><?><?><?><?><?> (DESCRIPTION)
       <?><?><?><?><?> kiwix-serve <?><?><?><?> <?><?><?><?><?> <?><?>
       <?><?><?><?> HTTP <?><?><?><?><?> <?><?> <?><?><?><?><?>
       <?><?><?><?><?> <?> <?><?><?><?><?><?><?><?><?> <?><?><?><?><?><?> ZIM
       <?><?><?> <?><?><?><?> <?><?><?><?><?><?><?> <?><?><?><?><?><?>.


<?><?><?><?><?><?><?><?><?><?> (ARGUMENTS)
       LIBRARY_FILE_PATH
              <?><?><?><?> <?><?><?><?> <?><?><?><?><?><?><?><?> XML <?><?>
              <?><?><?><?><?> <?><?><?><?><?><?><?><?> ZIM <?><?> <?><?><?><?>
              <?><?><?><?><?><?><?><?><?> <?><?><?><?><?><?><?>
              <?><?><?><?><?><?>. <?><?><?> <?><?><?><?><?> <?><?>
              <?><?><?><?><?> --library <?><?><?><?><?><?><?>
              <?><?><?><?><?><?>. <?><?><?><?><?> <?><?><?><?>
              <?><?><?><?><?><?><?><?> <?><?> <?><?><?><?><?><?><?> <?><?>
              <?><?><?><?> <?><?><?><?><?><?> <?><?><?><?><?><?> <?><?>
              <?><?><?><?> <?><?><?><?><?><?> (;) <?><?><?><?> <?><?><?>.


       ZIM_FILE_PATH ...
              <?><?><?><?> <?><?><?><?>(<?><?><?>) ZIM. <?><?><?><?><?><?><?>
              <?><?> <?><?><?><?><?> <?><?><?><?><?><?><?> <?><?><?><?>
              <?><?><?>.


<?><?><?><?><?><?><?><?> (OPTIONS)
       --library
              <?><?> <?><?><?> <?><?><?><?><?><?><?><?> kiwix-serve
              <?><?><?><?><?><?> <?><?><?><?><?><?> <?><?>
              <?><?><?><?><?><?><?><?> ZIM <?><?> <?><?> <?><?><?><?><?>
              <?><?><?><?><?><?><?><?><?><?><?> <?><?> <?><?><?><?><?>
              <?><?><?><?>. <?><?><?><?><?> <?><?><?><?><?> --library <?><?>
              kiwix-serve <?><?><?><?><?> <?><?><?><?><?><?> <?><?>
              <?><?><?><?><?><?><?> <?><?> <?><?><?><?><?><?> <?><?>
              <?><?><?><?> <?><?><?><?><?><?><?><?> XML <?><?><?>.


       -i ADDR, --address=ADDR
              <?><?><?><?> <?><?><?> <?><?><?> <?><?><?> <?><?><?><?> IP.
              <?><?> <?><?><?> <?><?><?><?><?><?><?><?> <?><?><?><?> <?><?><?>
              <?><?><?><?> <?><?><?><?><?><?><?><?> IP <?><?><?><?><?>
              <?><?><?><?> <?><?><?><?><?><?>. <?><?> <?><?><?>
              <?><?><?><?><?> <?><?><?><?><?><?><?><?><?> <?><?>
              <?><?><?><?><?><?> <?><?><?><?> <?><?><?> <?><?><?><?>
              <?><?><?><?><?> <?><?><?><?><?> <?><?><?><?><?><?><?><?><?>
              <?><?><?><?><?><?><?><?><?><?><?> <?><?><?><?><?><?><?>
              <?><?><?><?>:

       all : <?><?><?><?> <?><?><?><?> <?><?><?><?><?><?><?><?> <?><?><?> <?><?><?><?> <?><?><?><?><?><?><?><?> IP (IPv4 <?> IPv6).
       ipv4 : <?><?><?><?> <?><?><?><?> <?><?><?><?><?><?><?><?> <?><?><?> <?><?><?><?> <?><?><?><?><?><?><?><?> IPv4.
       ipv6 : <?><?><?><?> <?><?><?><?> <?><?><?><?><?><?><?><?> <?><?><?> <?><?><?><?> <?><?><?><?><?><?><?><?> IPv6.


       -p PORT, --port=PORT
              <?><?><?><?> TCP <?><?><?><?> <?><?><?><?>
              <?><?><?><?><?><?><?><?><?><?><?> HTTP (<?><?><?><?><?><?><?>:
              80).


       -r ROOT, --urlRootLocation=ROOT
              <?><?><?><?><?><?> URL <?><?> <?><?><?><?><?> <?><?><?><?>
              <?><?><?> <?><?> <?><?> <?><?><?><?><?> <?><?><?><?>
              <?><?><?><?> (<?><?><?><?><?><?><?>: <?><?><?><?>).


       -d, --daemon
              <?><?><?> <?><?><?><?> <?><?><?><?> <?><?><?><?> HTTP <?><?>
              <?><?><?><?><?><?> <?><?><?><?> (<?><?><?><?> <?><?>
              <?><?><?><?><?><?><?><?>).


       -a PID, --attachToProcess=PID
              <?><?><?><?> <?><?> <?><?><?><?> <?><?><?><?><?> <?><?><?>
              <?><?><?><?><?><?> <?><?> <?><?><?><?><?> PID.


       -M, --monitorLibrary
              <?><?><?><?> <?><?><?><?> <?><?><?><?><?><?><?><?> XML <?>
              <?><?><?><?><?><?><?><?> <?><?><?><?> <?><?><?><?><?><?> <?><?>
              <?><?><?><?><?> <?><?><?><?><?> <?><?><?><?><?>.

       <?><?><?><?><?><?><?><?> <?><?><?><?> <?><?><?><?><?><?><?><?> <?><?>
       <?><?> <?><?><?><?> <?><?> <?><?><?><?><?> <?><?><?><?><?><?> SIGHUP
       <?><?> <?><?><?><?><?><?> "kiwix-serve" <?><?><?><?><?><?><?><?><?><?>
       <?><?><?> (<?><?><?> <?><?><?><?><?><?> <?><?><?> <?><?><?> <?><?>
       <?><?><?><?> <?><?><?><?><?> "--monitorLibrary"/"-M" <?><?><?>
       <?><?><?><?><?><?>).


       -m, --nolibrarybutton
              <?><?><?><?><?><?><?> <?><?><?><?> <?><?><?><?> <?><?><?><?>
              <?><?><?><?> <?><?><?><?><?><?><?><?> <?><?> <?><?><?><?>
              <?><?><?><?><?> <?><?><?><?><?><?><?><?><?><?><?> ZIM.


       -n, --nosearchbar
              <?><?><?><?><?><?><?> <?><?><?><?> <?><?><?><?> <?><?><?><?><?>
              <?><?> <?><?><?><?> <?><?><?><?><?>
              <?><?><?><?><?><?><?><?><?><?><?> ZIM.


       -b, --blockexternal
              <?><?><?><?><?><?><?> <?><?> <?><?><?><?><?><?>
              <?><?><?><?><?><?> <?><?><?><?><?><?><?> <?><?> <?><?><?><?><?>
              <?><?><?><?><?> <?><?> <?><?><?><?> <?><?><?><?><?><?><?><?>
              <?><?><?><?><?> <?><?> <?><?><?><?><?><?> ZIM.


       -t N, --threads=N
              <?><?><?><?><?> <?><?><?><?><?><?> <?><?><?><?><?><?><?>
              <?><?><?><?> <?><?><?><?><?> <?><?><?><?><?>
              (<?><?><?><?><?><?><?>: 4).


       -s N, --searchLimit=N
              <?><?><?><?><?><?> <?><?><?><?><?> <?><?><?><?><?><?><?><?> ZIM
              <?><?> <?><?> <?><?><?><?><?><?> <?><?><?><?><?><?><?><?><?>
              <?><?><?><?> <?><?><?><?><?> <?><?><?><?> ZIM
              (<?><?><?><?><?><?><?>: <?><?><?><?> <?><?><?><?><?><?><?>).


       -z, --nodatealiases
              <?><?><?><?><?> <?><?><?><?><?><?><?> <?><?><?><?><?><?> URL
              <?><?><?><?> <?><?> <?><?><?><?><?> <?><?> <?><?><?><?>
              <?><?><?> <?><?><?><?><?> <?><?><?><?><?><?><?> <?><?> <?><?><?>
              <?><?><?><?>.

       <?><?><?><?> <?><?><?><?> <?><?><?><?><?><?> <?><?><?><?>
       <?><?><?><?><?> <?><?> <?><?><?> <?><?><?><?> <?><?> <?><?><?><?>
       "_YYYY-MM" <?><?><?>. <?><?><?><?> <?><?><?><?><?> <?><?> <?><?><?><?>
       ZIM <?><?> <?><?><?> "wikipedia_en_all_2020-08.zim" <?><?> <?><?>
       <?><?><?><?> "wikipedia_en_all_2020-08" <?> <?><?> <?><?> <?><?><?><?>
       "wikipedia_en_all" <?><?><?><?> <?><?><?><?><?><?> <?><?><?><?><?>
       <?><?><?>.


       -c PATH, --customIndex=PATH
              <?><?><?><?><?><?><?> <?><?><?><?> <?><?><?><?>
              <?><?><?><?><?><?><?><?><?><?><?> <?><?> <?><?> <?><?><?><?>
              HTML <?><?><?><?><?><?>.


       -L N, --ipConnectionLimit=N
              <?><?><?><?><?><?> <?><?><?><?><?> <?><?><?><?><?><?><?><?><?>
              (<?><?><?><?><?><?>) <?><?> <?><?><?><?> <?><?> IP
              (<?><?><?><?><?><?><?>: <?><?><?><?><?><?><?><?> <?><?><?><?><?>
              <?><?><?><?><?><?><?><?>: >= 6).


       -k, --skipInvalid
              <?><?><?><?><?><?><?><?><?><?> <?><?><?><?> <?><?><?> <?><?>
              <?><?><?><?> <?><?><?><?><?><?><?> <?><?><?><?> <?><?><?><?>
              <?><?><?><?><?><?><?><?> ZIM (<?><?><?><?><?><?><?><?>
              <?><?><?><?><?><?><?> <?><?><?><?><?><?> <?><?><?><?><?>
              <?><?><?><?><?><?><?>).


       -v, --verbose
              <?><?><?> <?><?><?><?><?><?><?><?><?>
              <?><?><?><?><?><?><?><?><?><?><?> <?><?> <?><?><?><?><?>
              <?><?><?><?><?><?><?><?><?> (STDOUT).


       -V, --version
              <?><?><?><?><?> <?><?><?><?> <?><?><?><?><?><?><?><?><?>.


       -h, --help
              <?><?><?><?><?> <?><?><?><?> <?><?><?><?><?><?>.


<?><?><?><?><?><?><?> (EXAMPLES)
       <?><?><?><?><?><?><?><?><?> <?><?> <?><?><?><?> ZIM <?><?><?><?><?>:

       kiwix-serve myzim.zim

       <?><?><?><?><?><?><?><?><?> <?><?><?><?><?> <?><?><?><?> ZIM:

       kiwix-serve zim1.zim zim2.zim zim3.zim

       <?><?><?><?><?><?><?><?><?> <?><?><?><?><?><?><?><?> ZIM <?><?>
       <?><?><?> <?><?> <?><?><?><?><?><?><?><?>:

       kiwix-serve --library library.xml


<?><?><?><?><?><?><?> (DOCUMENTATION)
       <?><?><?><?><?><?><?> <?><?><?><?>: https://kiwix-
       tools.readthedocs.io/en/latest/kiwix-serve.html
       <?><?> <?><?><?><?>: https://github.com/kiwix/kiwix-tools
       <?><?><?><?><?><?><?> <?><?><?><?><?>:
       https://wiki.kiwix.org/wiki/Kiwix-serve


<?><?><?><?><?><?><?><?><?> (AUTHORS)
       Emmanuel Engelhart <kelson@kiwix.org>
       Vasudev Kamath <kamathvasudev@gmail.com>

                            10 <?><?><?><?><?> 2023                   KIWIX(1)