From c1ac0c206f6b6d8eb1e529973fd07d4d3797ff51 Mon Sep 17 00:00:00 2001 From: G. Galdini Date: Thu, 14 Mar 2024 16:15:41 +0700 Subject: system/kiwix-tools-bin: Added (offline wikipedia). Signed-off-by: Willy Sudiarto Raharjo --- system/kiwix-tools-bin/README | 21 + system/kiwix-tools-bin/docs/AUTHORS | 14 + system/kiwix-tools-bin/docs/COPYING | 676 ++++++++++++++++++++++ system/kiwix-tools-bin/docs/Changelog | 367 ++++++++++++ system/kiwix-tools-bin/docs/README.md | 153 +++++ system/kiwix-tools-bin/docs/man/kiwix-manage.1 | 69 +++ system/kiwix-tools-bin/docs/man/kiwix-search.1 | 21 + system/kiwix-tools-bin/docs/man/kiwix-serve.1 | 136 +++++ system/kiwix-tools-bin/kiwix-tools-bin.SlackBuild | 76 +++ system/kiwix-tools-bin/kiwix-tools-bin.info | 10 + system/kiwix-tools-bin/slack-desc | 19 + 11 files changed, 1562 insertions(+) create mode 100644 system/kiwix-tools-bin/README create mode 100644 system/kiwix-tools-bin/docs/AUTHORS create mode 100644 system/kiwix-tools-bin/docs/COPYING create mode 100644 system/kiwix-tools-bin/docs/Changelog create mode 100644 system/kiwix-tools-bin/docs/README.md create mode 100644 system/kiwix-tools-bin/docs/man/kiwix-manage.1 create mode 100644 system/kiwix-tools-bin/docs/man/kiwix-search.1 create mode 100644 system/kiwix-tools-bin/docs/man/kiwix-serve.1 create mode 100644 system/kiwix-tools-bin/kiwix-tools-bin.SlackBuild create mode 100644 system/kiwix-tools-bin/kiwix-tools-bin.info create mode 100644 system/kiwix-tools-bin/slack-desc (limited to 'system') diff --git a/system/kiwix-tools-bin/README b/system/kiwix-tools-bin/README new file mode 100644 index 0000000000..44081c35d2 --- /dev/null +++ b/system/kiwix-tools-bin/README @@ -0,0 +1,21 @@ +kiwix-tools-bin (offline access for Wikipedia) + +Kiwix enables you to have the whole Wikipedia at hand wherever you go! +On a boat, in the middle of nowhere or in Jail, Kiwix gives you access +to the whole human knowledge. You don't need Internet, everything is +stored on your computer, USB flash drive or DVD! + +This is a repack of the official binary; it does not compile from +source. Only 32-bit x86, 64-bit x86_64, and 64-bit aarch64 are +supported. + +For aarch64, since there's currently no way to give the aarch64 download +URL in the .info file, you'll have to download it manually. The file is: + +https://download.kiwix.org/release/kiwix-tools/kiwix-tools_linux-aarch64-3.7.0.tar.gz + +md5 hash of this package: 12ab8a0d67dee5f63c0a85d9d089b5f2 + +Note: currently there is no kiwix-tools build that compiles from source. +If someday someone submits one, be aware that it will likely conflict +with this build. diff --git a/system/kiwix-tools-bin/docs/AUTHORS b/system/kiwix-tools-bin/docs/AUTHORS new file mode 100644 index 0000000000..df29bc970f --- /dev/null +++ b/system/kiwix-tools-bin/docs/AUTHORS @@ -0,0 +1,14 @@ +Emmanuel Engelhart +Renaud Gaudin +Christian Pühringer +Fabien Coullon +Guillaume Duhamel +Wilfredo Rodriguez +Jorge Gonzalez +Richzendy +Ayoub Dardory +Rashiq Ahmad +Isaac Hutt +Elad Keyshawn +Matthieu Gautier +Translatewiki comunity https://translatewiki.net/wiki/Translating:Kiwix diff --git a/system/kiwix-tools-bin/docs/COPYING b/system/kiwix-tools-bin/docs/COPYING new file mode 100644 index 0000000000..4432540474 --- /dev/null +++ b/system/kiwix-tools-bin/docs/COPYING @@ -0,0 +1,676 @@ + + GNU GENERAL PUBLIC LICENSE + Version 3, 29 June 2007 + + Copyright (C) 2007 Free Software Foundation, Inc. + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + Preamble + + The GNU General Public License is a free, copyleft license for +software and other kinds of works. + + The licenses for most software and other practical works are designed +to take away your freedom to share and change the works. By contrast, +the GNU General Public License is intended to guarantee your freedom to +share and change all versions of a program--to make sure it remains free +software for all its users. We, the Free Software Foundation, use the +GNU General Public License for most of our software; it applies also to +any other work released this way by its authors. You can apply it to +your programs, too. + + When we speak of free software, we are referring to freedom, not +price. Our General Public Licenses are designed to make sure that you +have the freedom to distribute copies of free software (and charge for +them if you wish), that you receive source code or can get it if you +want it, that you can change the software or use pieces of it in new +free programs, and that you know you can do these things. + + To protect your rights, we need to prevent others from denying you +these rights or asking you to surrender the rights. Therefore, you have +certain responsibilities if you distribute copies of the software, or if +you modify it: responsibilities to respect the freedom of others. + + For example, if you distribute copies of such a program, whether +gratis or for a fee, you must pass on to the recipients the same +freedoms that you received. You must make sure that they, too, receive +or can get the source code. And you must show them these terms so they +know their rights. + + Developers that use the GNU GPL protect your rights with two steps: +(1) assert copyright on the software, and (2) offer you this License +giving you legal permission to copy, distribute and/or modify it. + + For the developers' and authors' protection, the GPL clearly explains +that there is no warranty for this free software. For both users' and +authors' sake, the GPL requires that modified versions be marked as +changed, so that their problems will not be attributed erroneously to +authors of previous versions. + + Some devices are designed to deny users access to install or run +modified versions of the software inside them, although the manufacturer +can do so. This is fundamentally incompatible with the aim of +protecting users' freedom to change the software. The systematic +pattern of such abuse occurs in the area of products for individuals to +use, which is precisely where it is most unacceptable. Therefore, we +have designed this version of the GPL to prohibit the practice for those +products. If such problems arise substantially in other domains, we +stand ready to extend this provision to those domains in future versions +of the GPL, as needed to protect the freedom of users. + + Finally, every program is threatened constantly by software patents. +States should not allow patents to restrict development and use of +software on general-purpose computers, but in those that do, we wish to +avoid the special danger that patents applied to a free program could +make it effectively proprietary. To prevent this, the GPL assures that +patents cannot be used to render the program non-free. + + The precise terms and conditions for copying, distribution and +modification follow. + + TERMS AND CONDITIONS + + 0. Definitions. + + "This License" refers to version 3 of the GNU General Public License. + + "Copyright" also means copyright-like laws that apply to other kinds of +works, such as semiconductor masks. + + "The Program" refers to any copyrightable work licensed under this +License. Each licensee is addressed as "you". "Licensees" and +"recipients" may be individuals or organizations. + + To "modify" a work means to copy from or adapt all or part of the work +in a fashion requiring copyright permission, other than the making of an +exact copy. The resulting work is called a "modified version" of the +earlier work or a work "based on" the earlier work. + + A "covered work" means either the unmodified Program or a work based +on the Program. + + To "propagate" a work means to do anything with it that, without +permission, would make you directly or secondarily liable for +infringement under applicable copyright law, except executing it on a +computer or modifying a private copy. Propagation includes copying, +distribution (with or without modification), making available to the +public, and in some countries other activities as well. + + To "convey" a work means any kind of propagation that enables other +parties to make or receive copies. Mere interaction with a user through +a computer network, with no transfer of a copy, is not conveying. + + An interactive user interface displays "Appropriate Legal Notices" +to the extent that it includes a convenient and prominently visible +feature that (1) displays an appropriate copyright notice, and (2) +tells the user that there is no warranty for the work (except to the +extent that warranties are provided), that licensees may convey the +work under this License, and how to view a copy of this License. If +the interface presents a list of user commands or options, such as a +menu, a prominent item in the list meets this criterion. + + 1. Source Code. + + The "source code" for a work means the preferred form of the work +for making modifications to it. "Object code" means any non-source +form of a work. + + A "Standard Interface" means an interface that either is an official +standard defined by a recognized standards body, or, in the case of +interfaces specified for a particular programming language, one that +is widely used among developers working in that language. + + The "System Libraries" of an executable work include anything, other +than the work as a whole, that (a) is included in the normal form of +packaging a Major Component, but which is not part of that Major +Component, and (b) serves only to enable use of the work with that +Major Component, or to implement a Standard Interface for which an +implementation is available to the public in source code form. A +"Major Component", in this context, means a major essential component +(kernel, window system, and so on) of the specific operating system +(if any) on which the executable work runs, or a compiler used to +produce the work, or an object code interpreter used to run it. + + The "Corresponding Source" for a work in object code form means all +the source code needed to generate, install, and (for an executable +work) run the object code and to modify the work, including scripts to +control those activities. However, it does not include the work's +System Libraries, or general-purpose tools or generally available free +programs which are used unmodified in performing those activities but +which are not part of the work. For example, Corresponding Source +includes interface definition files associated with source files for +the work, and the source code for shared libraries and dynamically +linked subprograms that the work is specifically designed to require, +such as by intimate data communication or control flow between those +subprograms and other parts of the work. + + The Corresponding Source need not include anything that users +can regenerate automatically from other parts of the Corresponding +Source. + + The Corresponding Source for a work in source code form is that +same work. + + 2. Basic Permissions. + + All rights granted under this License are granted for the term of +copyright on the Program, and are irrevocable provided the stated +conditions are met. This License explicitly affirms your unlimited +permission to run the unmodified Program. The output from running a +covered work is covered by this License only if the output, given its +content, constitutes a covered work. This License acknowledges your +rights of fair use or other equivalent, as provided by copyright law. + + You may make, run and propagate covered works that you do not +convey, without conditions so long as your license otherwise remains +in force. You may convey covered works to others for the sole purpose +of having them make modifications exclusively for you, or provide you +with facilities for running those works, provided that you comply with +the terms of this License in conveying all material for which you do +not control copyright. Those thus making or running the covered works +for you must do so exclusively on your behalf, under your direction +and control, on terms that prohibit them from making any copies of +your copyrighted material outside their relationship with you. + + Conveying under any other circumstances is permitted solely under +the conditions stated below. Sublicensing is not allowed; section 10 +makes it unnecessary. + + 3. Protecting Users' Legal Rights From Anti-Circumvention Law. + + No covered work shall be deemed part of an effective technological +measure under any applicable law fulfilling obligations under article +11 of the WIPO copyright treaty adopted on 20 December 1996, or +similar laws prohibiting or restricting circumvention of such +measures. + + When you convey a covered work, you waive any legal power to forbid +circumvention of technological measures to the extent such circumvention +is effected by exercising rights under this License with respect to +the covered work, and you disclaim any intention to limit operation or +modification of the work as a means of enforcing, against the work's +users, your or third parties' legal rights to forbid circumvention of +technological measures. + + 4. Conveying Verbatim Copies. + + You may convey verbatim copies of the Program's source code as you +receive it, in any medium, provided that you conspicuously and +appropriately publish on each copy an appropriate copyright notice; +keep intact all notices stating that this License and any +non-permissive terms added in accord with section 7 apply to the code; +keep intact all notices of the absence of any warranty; and give all +recipients a copy of this License along with the Program. + + You may charge any price or no price for each copy that you convey, +and you may offer support or warranty protection for a fee. + + 5. Conveying Modified Source Versions. + + You may convey a work based on the Program, or the modifications to +produce it from the Program, in the form of source code under the +terms of section 4, provided that you also meet all of these conditions: + + a) The work must carry prominent notices stating that you modified + it, and giving a relevant date. + + b) The work must carry prominent notices stating that it is + released under this License and any conditions added under section + 7. This requirement modifies the requirement in section 4 to + "keep intact all notices". + + c) You must license the entire work, as a whole, under this + License to anyone who comes into possession of a copy. This + License will therefore apply, along with any applicable section 7 + additional terms, to the whole of the work, and all its parts, + regardless of how they are packaged. This License gives no + permission to license the work in any other way, but it does not + invalidate such permission if you have separately received it. + + d) If the work has interactive user interfaces, each must display + Appropriate Legal Notices; however, if the Program has interactive + interfaces that do not display Appropriate Legal Notices, your + work need not make them do so. + + A compilation of a covered work with other separate and independent +works, which are not by their nature extensions of the covered work, +and which are not combined with it such as to form a larger program, +in or on a volume of a storage or distribution medium, is called an +"aggregate" if the compilation and its resulting copyright are not +used to limit the access or legal rights of the compilation's users +beyond what the individual works permit. Inclusion of a covered work +in an aggregate does not cause this License to apply to the other +parts of the aggregate. + + 6. Conveying Non-Source Forms. + + You may convey a covered work in object code form under the terms +of sections 4 and 5, provided that you also convey the +machine-readable Corresponding Source under the terms of this License, +in one of these ways: + + a) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by the + Corresponding Source fixed on a durable physical medium + customarily used for software interchange. + + b) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by a + written offer, valid for at least three years and valid for as + long as you offer spare parts or customer support for that product + model, to give anyone who possesses the object code either (1) a + copy of the Corresponding Source for all the software in the + product that is covered by this License, on a durable physical + medium customarily used for software interchange, for a price no + more than your reasonable cost of physically performing this + conveying of source, or (2) access to copy the + Corresponding Source from a network server at no charge. + + c) Convey individual copies of the object code with a copy of the + written offer to provide the Corresponding Source. This + alternative is allowed only occasionally and noncommercially, and + only if you received the object code with such an offer, in accord + with subsection 6b. + + d) Convey the object code by offering access from a designated + place (gratis or for a charge), and offer equivalent access to the + Corresponding Source in the same way through the same place at no + further charge. You need not require recipients to copy the + Corresponding Source along with the object code. If the place to + copy the object code is a network server, the Corresponding Source + may be on a different server (operated by you or a third party) + that supports equivalent copying facilities, provided you maintain + clear directions next to the object code saying where to find the + Corresponding Source. Regardless of what server hosts the + Corresponding Source, you remain obligated to ensure that it is + available for as long as needed to satisfy these requirements. + + e) Convey the object code using peer-to-peer transmission, provided + you inform other peers where the object code and Corresponding + Source of the work are being offered to the general public at no + charge under subsection 6d. + + A separable portion of the object code, whose source code is excluded +from the Corresponding Source as a System Library, need not be +included in conveying the object code work. + + A "User Product" is either (1) a "consumer product", which means any +tangible personal property which is normally used for personal, family, +or household purposes, or (2) anything designed or sold for incorporation +into a dwelling. In determining whether a product is a consumer product, +doubtful cases shall be resolved in favor of coverage. For a particular +product received by a particular user, "normally used" refers to a +typical or common use of that class of product, regardless of the status +of the particular user or of the way in which the particular user +actually uses, or expects or is expected to use, the product. A product +is a consumer product regardless of whether the product has substantial +commercial, industrial or non-consumer uses, unless such uses represent +the only significant mode of use of the product. + + "Installation Information" for a User Product means any methods, +procedures, authorization keys, or other information required to install +and execute modified versions of a covered work in that User Product from +a modified version of its Corresponding Source. The information must +suffice to ensure that the continued functioning of the modified object +code is in no case prevented or interfered with solely because +modification has been made. + + If you convey an object code work under this section in, or with, or +specifically for use in, a User Product, and the conveying occurs as +part of a transaction in which the right of possession and use of the +User Product is transferred to the recipient in perpetuity or for a +fixed term (regardless of how the transaction is characterized), the +Corresponding Source conveyed under this section must be accompanied +by the Installation Information. But this requirement does not apply +if neither you nor any third party retains the ability to install +modified object code on the User Product (for example, the work has +been installed in ROM). + + The requirement to provide Installation Information does not include a +requirement to continue to provide support service, warranty, or updates +for a work that has been modified or installed by the recipient, or for +the User Product in which it has been modified or installed. Access to a +network may be denied when the modification itself materially and +adversely affects the operation of the network or violates the rules and +protocols for communication across the network. + + Corresponding Source conveyed, and Installation Information provided, +in accord with this section must be in a format that is publicly +documented (and with an implementation available to the public in +source code form), and must require no special password or key for +unpacking, reading or copying. + + 7. Additional Terms. + + "Additional permissions" are terms that supplement the terms of this +License by making exceptions from one or more of its conditions. +Additional permissions that are applicable to the entire Program shall +be treated as though they were included in this License, to the extent +that they are valid under applicable law. If additional permissions +apply only to part of the Program, that part may be used separately +under those permissions, but the entire Program remains governed by +this License without regard to the additional permissions. + + When you convey a copy of a covered work, you may at your option +remove any additional permissions from that copy, or from any part of +it. (Additional permissions may be written to require their own +removal in certain cases when you modify the work.) You may place +additional permissions on material, added by you to a covered work, +for which you have or can give appropriate copyright permission. + + Notwithstanding any other provision of this License, for material you +add to a covered work, you may (if authorized by the copyright holders of +that material) supplement the terms of this License with terms: + + a) Disclaiming warranty or limiting liability differently from the + terms of sections 15 and 16 of this License; or + + b) Requiring preservation of specified reasonable legal notices or + author attributions in that material or in the Appropriate Legal + Notices displayed by works containing it; or + + c) Prohibiting misrepresentation of the origin of that material, or + requiring that modified versions of such material be marked in + reasonable ways as different from the original version; or + + d) Limiting the use for publicity purposes of names of licensors or + authors of the material; or + + e) Declining to grant rights under trademark law for use of some + trade names, trademarks, or service marks; or + + f) Requiring indemnification of licensors and authors of that + material by anyone who conveys the material (or modified versions of + it) with contractual assumptions of liability to the recipient, for + any liability that these contractual assumptions directly impose on + those licensors and authors. + + All other non-permissive additional terms are considered "further +restrictions" within the meaning of section 10. If the Program as you +received it, or any part of it, contains a notice stating that it is +governed by this License along with a term that is a further +restriction, you may remove that term. If a license document contains +a further restriction but permits relicensing or conveying under this +License, you may add to a covered work material governed by the terms +of that license document, provided that the further restriction does +not survive such relicensing or conveying. + + If you add terms to a covered work in accord with this section, you +must place, in the relevant source files, a statement of the +additional terms that apply to those files, or a notice indicating +where to find the applicable terms. + + Additional terms, permissive or non-permissive, may be stated in the +form of a separately written license, or stated as exceptions; +the above requirements apply either way. + + 8. Termination. + + You may not propagate or modify a covered work except as expressly +provided under this License. Any attempt otherwise to propagate or +modify it is void, and will automatically terminate your rights under +this License (including any patent licenses granted under the third +paragraph of section 11). + + However, if you cease all violation of this License, then your +license from a particular copyright holder is reinstated (a) +provisionally, unless and until the copyright holder explicitly and +finally terminates your license, and (b) permanently, if the copyright +holder fails to notify you of the violation by some reasonable means +prior to 60 days after the cessation. + + Moreover, your license from a particular copyright holder is +reinstated permanently if the copyright holder notifies you of the +violation by some reasonable means, this is the first time you have +received notice of violation of this License (for any work) from that +copyright holder, and you cure the violation prior to 30 days after +your receipt of the notice. + + Termination of your rights under this section does not terminate the +licenses of parties who have received copies or rights from you under +this License. If your rights have been terminated and not permanently +reinstated, you do not qualify to receive new licenses for the same +material under section 10. + + 9. Acceptance Not Required for Having Copies. + + You are not required to accept this License in order to receive or +run a copy of the Program. Ancillary propagation of a covered work +occurring solely as a consequence of using peer-to-peer transmission +to receive a copy likewise does not require acceptance. However, +nothing other than this License grants you permission to propagate or +modify any covered work. These actions infringe copyright if you do +not accept this License. Therefore, by modifying or propagating a +covered work, you indicate your acceptance of this License to do so. + + 10. Automatic Licensing of Downstream Recipients. + + Each time you convey a covered work, the recipient automatically +receives a license from the original licensors, to run, modify and +propagate that work, subject to this License. You are not responsible +for enforcing compliance by third parties with this License. + + An "entity transaction" is a transaction transferring control of an +organization, or substantially all assets of one, or subdividing an +organization, or merging organizations. If propagation of a covered +work results from an entity transaction, each party to that +transaction who receives a copy of the work also receives whatever +licenses to the work the party's predecessor in interest had or could +give under the previous paragraph, plus a right to possession of the +Corresponding Source of the work from the predecessor in interest, if +the predecessor has it or can get it with reasonable efforts. + + You may not impose any further restrictions on the exercise of the +rights granted or affirmed under this License. For example, you may +not impose a license fee, royalty, or other charge for exercise of +rights granted under this License, and you may not initiate litigation +(including a cross-claim or counterclaim in a lawsuit) alleging that +any patent claim is infringed by making, using, selling, offering for +sale, or importing the Program or any portion of it. + + 11. Patents. + + A "contributor" is a copyright holder who authorizes use under this +License of the Program or a work on which the Program is based. The +work thus licensed is called the contributor's "contributor version". + + A contributor's "essential patent claims" are all patent claims +owned or controlled by the contributor, whether already acquired or +hereafter acquired, that would be infringed by some manner, permitted +by this License, of making, using, or selling its contributor version, +but do not include claims that would be infringed only as a +consequence of further modification of the contributor version. For +purposes of this definition, "control" includes the right to grant +patent sublicenses in a manner consistent with the requirements of +this License. + + Each contributor grants you a non-exclusive, worldwide, royalty-free +patent license under the contributor's essential patent claims, to +make, use, sell, offer for sale, import and otherwise run, modify and +propagate the contents of its contributor version. + + In the following three paragraphs, a "patent license" is any express +agreement or commitment, however denominated, not to enforce a patent +(such as an express permission to practice a patent or covenant not to +sue for patent infringement). To "grant" such a patent license to a +party means to make such an agreement or commitment not to enforce a +patent against the party. + + If you convey a covered work, knowingly relying on a patent license, +and the Corresponding Source of the work is not available for anyone +to copy, free of charge and under the terms of this License, through a +publicly available network server or other readily accessible means, +then you must either (1) cause the Corresponding Source to be so +available, or (2) arrange to deprive yourself of the benefit of the +patent license for this particular work, or (3) arrange, in a manner +consistent with the requirements of this License, to extend the patent +license to downstream recipients. "Knowingly relying" means you have +actual knowledge that, but for the patent license, your conveying the +covered work in a country, or your recipient's use of the covered work +in a country, would infringe one or more identifiable patents in that +country that you have reason to believe are valid. + + If, pursuant to or in connection with a single transaction or +arrangement, you convey, or propagate by procuring conveyance of, a +covered work, and grant a patent license to some of the parties +receiving the covered work authorizing them to use, propagate, modify +or convey a specific copy of the covered work, then the patent license +you grant is automatically extended to all recipients of the covered +work and works based on it. + + A patent license is "discriminatory" if it does not include within +the scope of its coverage, prohibits the exercise of, or is +conditioned on the non-exercise of one or more of the rights that are +specifically granted under this License. You may not convey a covered +work if you are a party to an arrangement with a third party that is +in the business of distributing software, under which you make payment +to the third party based on the extent of your activity of conveying +the work, and under which the third party grants, to any of the +parties who would receive the covered work from you, a discriminatory +patent license (a) in connection with copies of the covered work +conveyed by you (or copies made from those copies), or (b) primarily +for and in connection with specific products or compilations that +contain the covered work, unless you entered into that arrangement, +or that patent license was granted, prior to 28 March 2007. + + Nothing in this License shall be construed as excluding or limiting +any implied license or other defenses to infringement that may +otherwise be available to you under applicable patent law. + + 12. No Surrender of Others' Freedom. + + If conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot convey a +covered work so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you may +not convey it at all. For example, if you agree to terms that obligate you +to collect a royalty for further conveying from those to whom you convey +the Program, the only way you could satisfy both those terms and this +License would be to refrain entirely from conveying the Program. + + 13. Use with the GNU Affero General Public License. + + Notwithstanding any other provision of this License, you have +permission to link or combine any covered work with a work licensed +under version 3 of the GNU Affero General Public License into a single +combined work, and to convey the resulting work. The terms of this +License will continue to apply to the part which is the covered work, +but the special requirements of the GNU Affero General Public License, +section 13, concerning interaction through a network will apply to the +combination as such. + + 14. Revised Versions of this License. + + The Free Software Foundation may publish revised and/or new versions of +the GNU General Public License from time to time. Such new versions will +be similar in spirit to the present version, but may differ in detail to +address new problems or concerns. + + Each version is given a distinguishing version number. If the +Program specifies that a certain numbered version of the GNU General +Public License "or any later version" applies to it, you have the +option of following the terms and conditions either of that numbered +version or of any later version published by the Free Software +Foundation. If the Program does not specify a version number of the +GNU General Public License, you may choose any version ever published +by the Free Software Foundation. + + If the Program specifies that a proxy can decide which future +versions of the GNU General Public License can be used, that proxy's +public statement of acceptance of a version permanently authorizes you +to choose that version for the Program. + + Later license versions may give you additional or different +permissions. However, no additional obligations are imposed on any +author or copyright holder as a result of your choosing to follow a +later version. + + 15. Disclaimer of Warranty. + + THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY +APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT +HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY +OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, +THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR +PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM +IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF +ALL NECESSARY SERVICING, REPAIR OR CORRECTION. + + 16. Limitation of Liability. + + IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS +THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY +GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE +USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF +DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD +PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), +EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF +SUCH DAMAGES. + + 17. Interpretation of Sections 15 and 16. + + If the disclaimer of warranty and limitation of liability provided +above cannot be given local legal effect according to their terms, +reviewing courts shall apply local law that most closely approximates +an absolute waiver of all civil liability in connection with the +Program, unless a warranty or assumption of liability accompanies a +copy of the Program in return for a fee. + + END OF TERMS AND CONDITIONS + + How to Apply These Terms to Your New Programs + + If you develop a new program, and you want it to be of the greatest +possible use to the public, the best way to achieve this is to make it +free software which everyone can redistribute and change under these terms. + + To do so, attach the following notices to the program. It is safest +to attach them to the start of each source file to most effectively +state the exclusion of warranty; and each file should have at least +the "copyright" line and a pointer to where the full notice is found. + + + Copyright (C) + + This program is free software: you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation, either version 3 of the License, or + (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License + along with this program. If not, see . + +Also add information on how to contact you by electronic and paper mail. + + If the program does terminal interaction, make it output a short +notice like this when it starts in an interactive mode: + + Copyright (C) + This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. + This is free software, and you are welcome to redistribute it + under certain conditions; type `show c' for details. + +The hypothetical commands `show w' and `show c' should show the appropriate +parts of the General Public License. Of course, your program's commands +might be different; for a GUI interface, you would use an "about box". + + You should also get your employer (if you work as a programmer) or school, +if any, to sign a "copyright disclaimer" for the program, if necessary. +For more information on this, and how to apply and follow the GNU GPL, see +. + + The GNU General Public License does not permit incorporating your program +into proprietary programs. If your program is a subroutine library, you +may consider it more useful to permit linking proprietary applications with +the library. If this is what you want to do, use the GNU Lesser General +Public License instead of this License. But first, please read +. + diff --git a/system/kiwix-tools-bin/docs/Changelog b/system/kiwix-tools-bin/docs/Changelog new file mode 100644 index 0000000000..680756cee0 --- /dev/null +++ b/system/kiwix-tools-bin/docs/Changelog @@ -0,0 +1,367 @@ +kiwix-tools 3.7.0 +================= + + * Fixed ZIM name vs Book name confusion in documentation (@veloman-yunkan #663) + * Fixes compilation dependencies to rely on appropriate version (@kelson42 #667) + * New --skipInvalid Kiwix Server command line option (@schuellerf @kelson42 #666) + +kiwix-tools 3.6.0 +================= + + * Improved kiwix-serve man page (@iArchitSharma #626) + * C++17 compliant code base (@mgautierfr #636) + * Support of libkiwix13 (@mgautierfr #633) + * Additional docker images archs for armv6 and i386 (@rgaudin #622) + +kiwix-tools 3.5.0 +================= + + * Do not use `--static` option when compiling on MacOs (@mgautierfr #615) + * Move main branch from `master` to `main`. + * Fix docker image (@jacroe #597) + * Various CI improvements (@kelson42) + +kiwix-serve +----------- + + * Add documentation about the kiwix-serve API (@veloman-yunkan #586) + https://kiwix-tools.readthedocs.io/en/latest/kiwix-serve.html#http-api + +kiwix-tools 3.4.0 +================= + + * Remove last reference to kiwix-read tool (@legoktm #569) + +kiwix-serve +----------- + + * Fix broken indentation in usage (@kelson42 #560) + * Exit if wrong arguments are passed (@kelson42 #567) + * Do not allow multiple values for same option (@juuz0 #564) + * Fix default location of "rootLocation" (@rgaudin #571) + * [DOCKER] Change default port to 8080 (@neyder #581) + * [DOCKER] Simplify dockerfile (@rgaudin #582) + +kiwix-manage +------------ + + * Fix man page (@kelson42 #576) + +kiwix-tools 3.3.0 +================= + + * Remove kiwix-read tool (@veloman-yunkan #535) + +kiwix-serve +----------- + + * Add an option to limit the number of connections for a same IP (@juuz0 #534) + * Add an option to limit the number of zim in a multizim fulltext search (@mgautierfr #558) + +kiwix-search +------------ + + * Remove usage of libkiwix's deprecated api (@veloman-yunkan #535) + +kiwix-manage +------------ + + * Correctly return a value !0 if something went wrong (@mgautierfr #553) + + +kiwix-tools 3.2.0 +================= + + * Print the version of all dependencies (@kelson42 #516) + * Better Docker images (@kelson42 @rgaudin) + * Update Readme (@kelson42) + * Build debian packages on CI (@legoktm #394) + * Add man pages for kiwix-read and kiwix-search (@legoktm #392) + * Various fixes (@legoktm @hashworks @mgautierfr) + + +kiwix-serve +----------- + + * Print the url on which a user can connect to on startup (@juuz0 #499 #522) + * Reload library on SIGHUP signal (@veloman-yunkan #497) + * Add a option `--monitorLibrary` to monitor and automically reload the library + (@veloman-yunkan #503) + * Correct handling of SIGTERM and SIGINT (@veloman-yunkan #488) + * Add `--customIndexTemplate` option (@manan #477) + * Add `--help` option (@kelson42 #511) + + +kiwix-tools 3.1.2 +================= + + * Use new threadsafe API of kiwix-lib to do suggestions search. + +kiwix-tools 3.1.1 +================= + + * Fix compilation on Windows' CI + +kiwix-tools 3.1.0 +================= + + * [SERVER] Add option to block external links + +kiwix-tools 3.0.3 +================= + + * [MANAGER] Fix broken --version argument parsing + +kiwix-tools 3.0.2 +================= + + * New option --version for all tools + * Remove benchmark.sh file. + * [DOCKER] Add ability to download a file at container start. + * [CI] Move to github actions instead of travis. + * [SERVER] Trust the given library by default. + * [SERVER] Add shortcut alias for option `--address` and `--nodatealias` + +kiwix-tools 3.0.1 +================= + + * Fix --nodatealiases inverted logic regression + +kiwix-tools 3.0.0 +================= + + * Move kiwix-serve implementation in kiwix-lib. + +kiwix-tools 2.1.0 +================= + + * Fix few compilation errors. + +kiwix-serve +----------- + + * Use new api to filter the library. + * Mobile friendly top bar. + * Add notag parameter to be able to exclude tags from the zim search. + + +kiwix-tools 2.0.0 +================= + +kiwix-manage +----------- + + * Better usage() + * Adding multiple files bug fix + * Remove download command. + +kiwix-serve +----------- + + * Better usage() + * Display properly welcome page on 3 columns + * New welcome page footer "Powered by Kiwix" + +kiwix-tools 1.2.1 +================= + +kiwix-serve +----------- + + * Always use POLL when avaible. + +kiwix-tools 1.2.0 +================= + + * Remove rpath for installed binaries. + +kiwix-serve +----------- + + * New Dockerfile of kiwix-serve + * New --nodatealiases option + * Do not use POLL on windows + +kiwix-manage +------------ + + * Do not show all books if book ids has been provided. + * Be able to add several zim files in the same time in a library. + +kiwix-tools 1.1.0 +================= + +kiwix-serve +----------- + + * Fix bug about handling of absolute url in old zim file. + * All the catalog to be searched by tags. + +kiwix-tools 1.0.0 +================= + + * [CI] Use the new deps archive xz + * Move version 1.0.0. There is no need to stay in pre 1.0 version. + +kiwix-serve +----------- + + * Correctly implement redirection. + kiwix-serve now return a 302 http status code instead of resolving the + redirection internally and return the content. + + +kiwix-tools 0.9.0 +================= + + * Update README + * Update man pages + * Remove support of external indexes (manage, search, serve) + * Update build system as we don't use ctpp2 anymore + * Update to last kiwix-lib API. + +kiwix-manage +------------ + + * Update usage. + + +kiwix-tools 0.8.0 +================= + +kiwix-manage +------------ + + * Be able to remove several books from the library in one command. + +kiwix-tools 0.7.0 +================= + + * Adapt to kiwix-lib new API + +kiwix-serve +----------- + + * Dumps only valid books in the opdsfeed. + * Allow the opds feed to be filtered by lang and paginated. + +kiwix-manage +------------ + + * Add a download command to download a remote book locally + * Book are referenced by bookId not index. + * No more indexType option as it is always XAPIAN. + +kiwix-tools 0.6.1 +================= + +kiwix-serve +----------- + + * Update README. + * Fix crash when `--library` flag is provided without value. + * Correctly handle mimetype of file without extension on 64bits. + * Minor fixes + +kiwix-tools 0.6.0 +================= + + * remove kiwix-install tool. + +kiwix-serve +----------- + + * Improved taskbar #160 + * Fix global page when using the option `--nosearchbar` + * Return 404 for missing resources + * Fix compilation for gcc 4.8. + +kiwix-manage +------------ + + * Returns proper exit code (not always 0) + + +kiwix-tools 0.5.0 +================= + + * Build kiwix-tools setting the RPATH + * Compile without warning. + + +kiwix-serve +------------ + + * Serve metadata information using the "/meta" url. + * Serve an OPDS stream of all zim handled by kiwix-serve + All informations cannot be infer from the zim file itself, + you should use a library.xml to provide needed information (url, ...) + * Update kiwix-serve to use the new API of kiwix-lib + +kiwix-tools 0.4.0 +================= + + * Use gcc-5 on travis. + +kiwix-serve +----------- + + * Accept zim file with `&` in the name + * Do not cache (on client side) global search (as it can depends on the zim + files handled) + * Fix HTTP byte range handling. (#91) + * Fix opening of relative path (#70) + * Add a small (and hidden) API to do geo search. + * Better request parsing. (#91) + * Better handling of invalid request (#116) + * Various bug fixes (#146, #150, #153, #165, #168, #165) + +kiwix-search +------------ + + * Add an option `--suggestion` to do suggestion search with + kiwix-search.(#132) + +kiwix-tools 0.3.0 +================= + + * Move to C++11 + +kiwix-serve +----------- + + * Add a global taskbar in the welcome page to search in all zims (#49) + * Serve the taskbar as css file instead of including it in the html (#68): + * Better client caching + * The html encoding is now in the first 1024 bytes and firefox correctly + detect the encoding + * Make kiwix-server multi-threaded (#82) + * Correctly return 404 instead of crashing when request inexistant skin file + (#83) + * Correctly respond to bytes-range requests.(#84) + * Directly respond to first request for a url instead of refusing the first + connexion + * Add support to relative url location. (#86) + * Remove caching (on client side) for the welcome page. (#86) + + +kiwix-tools 0.2.0 +================= + + * Remove indexer tools + +kiwix-serve +----------- + + * Correctly fix the deflate data we send over http. (#15) + * Update in the taskbar (or topbar): + * Taskbar is responsive (github.com/kiwix/kiwix/issues/336) + * Force css rules for the taskbar (and not be impacted by content's css) + * Add `--nolibrarybutton` to hide the library button from the taskbar. + * Rewrite of the welcome page. + + +kiwix-installer +--------------- + + * Remove indexing functionnality diff --git a/system/kiwix-tools-bin/docs/README.md b/system/kiwix-tools-bin/docs/README.md new file mode 100644 index 0000000000..81457d8eba --- /dev/null +++ b/system/kiwix-tools-bin/docs/README.md @@ -0,0 +1,153 @@ +Kiwix tools +=========== + +The Kiwix tools is a collection of [Kiwix](https://kiwix.org) related +command line tools: +* kiwix-manage: Manage XML based library of ZIM files +* kiwix-search: Full text search in ZIM files +* kiwix-serve: HTTP daemon serving ZIM files + +[![latest release](https://img.shields.io/github/v/tag/kiwix/kiwix-tools?label=latest%20release&sort=semver)](https://download.kiwix.org/release/kiwix-tools/) +[![Repositories](https://img.shields.io/repology/repositories/kiwix-tools?label=repositories)](https://github.com/kiwix/kiwix-tools/wiki/Repology) +[![Docker](https://ghcr-badge.deta.dev/kiwix/kiwix-tools/latest_tag?label=docker)](https://ghcr.io/kiwix/kiwix-tools) +[![Docker](https://ghcr-badge.deta.dev/kiwix/kiwix-tools/latest_tag?label=docker%20(kiwix-serve))](https://ghcr.io/kiwix/kiwix-tools) +[![Sandstorm](https://img.shields.io/badge/Sandstorm-kiwix-blue)](https://apps.sandstorm.io/app/5uh349d0kky2zp5whrh2znahn27gwha876xze3864n0fu9e5220h) +[![Build Status](https://github.com/kiwix/kiwix-tools/workflows/CI/badge.svg?query=branch%3Amain)](https://github.com/kiwix/kiwix-tools/actions?query=branch%3Amain) +[![Doc](https://readthedocs.org/projects/kiwix-tools/badge/?style=flat)](https://kiwix-tools.readthedocs.org/en/latest/?badge=latest) +[![CodeFactor](https://www.codefactor.io/repository/github/kiwix/kiwix-tools/badge)](https://www.codefactor.io/repository/github/kiwix/kiwix-tools) +[![License: GPL v3](https://img.shields.io/badge/License-GPLv3-blue.svg)](https://www.gnu.org/licenses/gpl-3.0) + +Disclaimer +---------- + +This document assumes you have a little knowledge about software +compilation. If you experience difficulties with the dependencies or +with the Kiwix tools compilation itself, we recommend to have a look +to [kiwix-build](https://github.com/kiwix/kiwix-build). + +Preamble +-------- + +Although the Kiwix tools can be compiled/cross-compiled on/for many +systems, the following documentation explains how to do it on POSIX +ones. It is primarily thought for GNU/Linux systems and has been tested +on recent releases of +[Debian](https://debian.org)/[Ubuntu](https://ubuntu.com) and +[Fedora](https://getfedora.org). + +Dependencies +------------ + +The Kiwix tools rely on a few third party software libraries. They are +prerequisites to the Kiwix tools compilation. Therefore, following +libraries need to be available: +* [libkiwix](https://github.com/kiwix/libkiwix) (package `libkiwix` on Debian/Ubuntu) +* [libzim](https://github.com/openzim/libzim) (package `libzim` on Debian/Ubuntu) + +These dependencies may or may not be packaged by your operating +system. They may also be packaged but only in an older version. They +may be also packaged but without providing a static version. The +compilation script will tell you if one of them is missing or too old. +In the worse case, you will have to download and compile bleeding edge +version by hand. + +If you want to install these dependencies locally, then use the +kiwix-tools directory as install prefix. + +If you want to compile Kiwix tools statically, the dependencies should +be compiled statically (provide a `lib...a` library), for example by +using `--enable-static` with `./configure`. + +Environment +------------- + +The Kiwix tools build using [Meson](http://mesonbuild.com/) version +0.43 or higher. Meson relies itself on Ninja, pkg-config and a few other +compilation tools. Install them first: +* [Meson](http://mesonbuild.com/) +* [Ninja](https://ninja-build.org/) +* [pkg-config](https://www.freedesktop.org/wiki/Software/pkg-config/) + +These tools should be packaged if you use a cutting edge operating +system. If not, have a look to the [Troubleshooting](#Troubleshooting) +section. + +Compilation +----------- + +Once all dependencies are installed, you can compile Kiwix tools with: +```bash +meson . build +ninja -C build +``` + +By default, it will compile dynamic linked libraries. If you want +statically linked libraries, you can add `-Dstatic-linkage=true` +option to the Meson command. + +Depending of you system, `ninja` may be called `ninja-build`. + +Installation +------------ + +If you want to install the Kiwix tools, here we go: +```bash +ninja -C build install +``` + +You might need to run the command as `root` (or using `sudo`), +depending on where you want to install the Kiwix tools. After the +installation succeeded, you may need to run ldconfig (as `root`). + +Uninstallation +------------ + +If you want to uninstall the Kiwix tools: +```bash +ninja -C build uninstall +``` + +Like for the installation, you might need to run the command as `root` +(or using `sudo`). + +Docker +------ + +An official Docker image of the Kiwix tools can be found on +[GHCR](https://ghcr.io/kiwix/kiwix-tools). A +`kiwix-serve` dedicated Docker image [exists +too](https://ghcr.io/kiwix/kiwix-serve). + +Troubleshooting +--------------- + +If you need to install Meson "manually": +```bash +virtualenv -p python3 ./ # Create virtualenv +source bin/activate # Activate the virtualenv +pip3 install meson # Install Meson +hash -r # Refresh bash paths +``` + +If you need to install Ninja "manually": +```bash +git clone git://github.com/ninja-build/ninja.git +cd ninja +git checkout release +./configure.py --bootstrap +mkdir ../bin +cp ninja ../bin +cd .. +``` + +If the compilation still fails, you might need to get a more recent +version of a dependency than the one packaged by your Linux +distribution. Try then with a source tarball distributed by the +problematic upstream project or even directly from the source code +repository. + +License +------- + +[GPLv3](https://www.gnu.org/licenses/gpl-3.0) or later, see +[COPYING](COPYING) for more details. diff --git a/system/kiwix-tools-bin/docs/man/kiwix-manage.1 b/system/kiwix-tools-bin/docs/man/kiwix-manage.1 new file mode 100644 index 0000000000..fe5d0420ba --- /dev/null +++ b/system/kiwix-tools-bin/docs/man/kiwix-manage.1 @@ -0,0 +1,69 @@ +.TH KIWIX-MANAGE 1 "21 May 2012" + +.SH NAME +kiwix\-manage \- Kiwix Library Manager + +.SH SYNOPSIS +.IX Header SYNOPSIS +.TP +\fBkiwix\-manage\fR LIBRARY_PATH \fBadd\fR ZIM_PATH ... +.TP +\fBkiwix\-manage\fR LIBRARY_PATH \fBshow\fR [ZIM_ID_1] [ZIM_ID_2] ... +.TP +\fBkiwix\-manage\fR LIBRARY_PATH \fBremove\fR ZIM_ID_1 [ZIM_ID_2] ... +.TP +\fBkiwix\-manage\fR --version +.TP +\fBkiwix\-manage\fR --help + +.SH DESCRIPTION +.PP +\fBkiwix\-manage\fP is a command line tool for manipulating a Kiwix XML library. +.PP +\fBkiwix\-manage\fP allows to manage the entries of the Kiwix +library. The library file is a flat XML file listing ZIM files with +all necessary information like id, favicon, date, creator, +description, filepath, title, url, etc. + +.SH ACTIONS + +.TP +\fBadd\fR +Add \fBZIM_FILE\fP to \fBLIBRARY_FILE\fP. Create the library file if necessary. + +.TP +\fBremove\fR +Remove the given \fBZIM_ID\fR from \fBLIBRARY_FILE\fR. At least one \fBZIM_ID\fR should be specified. + +.TP +\fBshow\fR +Show given \fBZIM_ID\fP from \fBLIBRARY_FILE\fR. If no \fBZIM_ID\fP is given then all contents from \fBLIBRARY_FILE\fR are shown. + +.SH OPTIONS +.TP +Options to be used with the action \fBadd\fR: + +.TP +\fB\-\-url=HTTP_URL\fR +Set the ZIM online HTTP(S) URL + +.TP +\fB\-\-zimPathToSave=OTHER_FS_PATH\fR +Set an arbitrary ZIM filesystem path (instead of the ZIM_PATH) + +.TP +Other options (to be used alone): + +.TP +\fB\-\-help | \-h\fR +Display the kiwix-manage help + +.TP +\fB\-\-version | \-v\fR +Display the version of kiwix-manage and all dependences + +.SH SEE ALSO +kiwix\-serve(1) + +.SH AUTHORS +Kiwix team diff --git a/system/kiwix-tools-bin/docs/man/kiwix-search.1 b/system/kiwix-tools-bin/docs/man/kiwix-search.1 new file mode 100644 index 0000000000..43b61cc46e --- /dev/null +++ b/system/kiwix-tools-bin/docs/man/kiwix-search.1 @@ -0,0 +1,21 @@ +.TH KIWIX-SEARCH "1" "July 2020" "kiwix-tools" "User Commands" +.SH NAME +kiwix-search \- find articles using a fulltext search pattern +.SH SYNOPSIS +\fBkiwix-search\fR [OPTIONS] ZIM PATTERN\fR +.SH DESCRIPTION +.TP +ZIM +ZIM file to search +.TP +PATTERN +Words or parts of words to search for in the ZIM file +.TP +\fB\-s\fR, \fB\-\-suggestion\fR +Suggest article titles based on the PATTERN instead of a fulltext search +.TP +\fB\-V\fR, \fB\-\-version\fR +print software version +.TP +\fB\-v\fR, \fB\-\-verbose\fR +Give details about the search process diff --git a/system/kiwix-tools-bin/docs/man/kiwix-serve.1 b/system/kiwix-tools-bin/docs/man/kiwix-serve.1 new file mode 100644 index 0000000000..69d86b462e --- /dev/null +++ b/system/kiwix-tools-bin/docs/man/kiwix-serve.1 @@ -0,0 +1,136 @@ +.TH KIWIX 1 "10 July 2023" + +.SH NAME +kiwix-serve \- Kiwix HTTP Server + +.SH SYNOPSIS + +.B kiwix-serve --library [OPTIONS] LIBRARY_FILE_PATH +.br +.B kiwix-serve [OPTIONS] ZIM_FILE_PATH ... + +.SH DESCRIPTION +The \fBkiwix-serve\fR command is used to run a stand-alone HTTP server for serving ZIM contents over the network. + +.SH ARGUMENTS +.TP +\fBLIBRARY_FILE_PATH\fR +Path of an XML library file listing ZIM files to serve. To be used only with the --library option. Multiple library files can be provided as a semicolon (;) separated list. + +.TP +\fBZIM_FILE_PATH ...\fR +ZIM file path(s). Multiple arguments are allowed. + +.SH OPTIONS +.TP +\fB--library\fR +By default, kiwix-serve expects a list of ZIM files as command line arguments. Providing the --library option tells kiwix-serve that the command line argument is rather a library XML file. + +.TP +\fB-i ADDR, --address=ADDR\fR +Listen only on this IP address. By default, the server listens on all available IP addresses. + +.TP +\fB-p PORT, --port=PORT\fR +TCP port on which to listen for HTTP requests (default: 80). + +.TP +\fB-r ROOT, --urlRootLocation=ROOT\fR +URL prefix on which the content should be made available (default: empty). + +.TP +\fB-d, --daemon\fR +Detach the HTTP server daemon from the main process. + +.TP +\fB-a PID, --attachToProcess=PID\fR +Exit when the process with id PID stops running. + +.TP +\fB-M, --monitorLibrary\fR +Monitor the XML library file and reload it automatically when it changes. + +Library reloading can be forced anytime by sending a SIGHUP signal to the +\*(lqkiwix-serve\*(rq process (this works regardless of the presence of the +\*(lq--monitorLibrary\*(rq/\*(lq-M\*(rq option). + +.TP +\fB-m, --nolibrarybutton\fR +Disable the library home button in the ZIM viewer toolbar. + +.TP +\fB-n, --nosearchbar\fR +Disable the search box in the ZIM viewer toolbar. + +.TP +\fB-b, --blockexternal\fR +Prevent users from directly navigating to external resources via links in ZIM content. + +.TP +\fB-t N, --threads=N\fR +Number of threads to run in parallel (default: 4). + +.TP +\fB-s N, --searchLimit=N\fR +Maximum number of ZIM files in a fulltext multizim search (default: No limit). + +.TP +\fB-z, --nodatealiases\fR +Create URL aliases for each content by removing the date embedded in the file name. + +The expected format of the date in the filename is \*(lq_YYYY-MM\*(rq. For example, a ZIM file named \*(lqwikipedia_en_all_2020-08.zim\*(rq will be accessible both as \*(lqwikipedia_en_all_2020-08\*(rq and \*(lqwikipedia_en_all\*(rq. + +.TP +\fB-c PATH, --customIndex=PATH\fR +Override the welcome page with a custom HTML file. + +.TP +\fB-L N, --ipConnectionLimit=N\fR +Max number of (concurrent) connections per IP (default: infinite, recommended: >= 6). + +.TP +\fB-k, --skipInvalid\fR +Startup even when ZIM files are invalid (those will be skipped) + +.TP +\fB-v, --verbose\fR +Print debug log to STDOUT. + +.TP +\fB-V, --version\fR +Print the software version. + +.TP +\fB-h, --help\fR +Print a help message. + +.SH EXAMPLES +Serve a single ZIM file: +.sp +.nf +.B kiwix-serve myzim.zim +.fi + +Serve multiple ZIM files: +.sp +.nf +.B kiwix-serve zim1.zim zim2.zim zim3.zim +.fi + +Serve ZIM files from a library: +.sp +.nf +.B kiwix-serve --library library.xml +.fi + +.SH DOCUMENTATION +Online documentation: https://kiwix-tools.readthedocs.io/en/latest/kiwix-serve.html +.br +Source code: https://github.com/kiwix/kiwix-tools +.br +More info: https://wiki.kiwix.org/wiki/Kiwix-serve + +.SH AUTHORS +Emmanuel Engelhart +.br +Vasudev Kamath diff --git a/system/kiwix-tools-bin/kiwix-tools-bin.SlackBuild b/system/kiwix-tools-bin/kiwix-tools-bin.SlackBuild new file mode 100644 index 0000000000..4e9e4115be --- /dev/null +++ b/system/kiwix-tools-bin/kiwix-tools-bin.SlackBuild @@ -0,0 +1,76 @@ +#!/bin/bash + +# Slackware build script for kiwix-tools-bin + +# Copyright 2024 G. Galdini Brazil +# All rights reserved. +# +# Redistribution and use of this script, with or without modification, is +# permitted provided that the following conditions are met: +# +# 1. Redistributions of this script must retain the above copyright +# notice, this list of conditions and the following disclaimer. +# +# THIS SOFTWARE IS PROVIDED BY THE AUTHOR "AS IS" AND ANY EXPRESS OR IMPLIED +# WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF +# MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO +# EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, +# SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, +# PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; +# OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, +# WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR +# OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF +# ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + +cd $(dirname $0) ; CWD=$(pwd) + +PRGNAM=kiwix-tools-bin +VERSION=${VERSION:-3.7.0} +BUILD=${BUILD:-1} +TAG=${TAG:-_SBo} +PKGTYPE=${PKGTYPE:-tgz} + +case "${ARCH:-$(uname -m)}" in + i?86) ARCH=i586 ;; + aarch64) ARCH=aarch64 ;; + x86_64) ARCH=x86_64 ;; + *) echo 'This script not support your architecture.' ; exit 1 ;; +esac + +if [ ! -z "${PRINT_PACKAGE_NAME}" ]; then + echo "$PRGNAM-$VERSION-$ARCH-$BUILD$TAG.$PKGTYPE" + exit 0 +fi + +TMP=${TMP:-/tmp/SBo} +PKG=$TMP/package-$PRGNAM +OUTPUT=${OUTPUT:-/tmp} + +# Binaries already stripped +PBIN=${PRGNAM%-bin}_linux-${ARCH}-${VERSION} + +set -e + +rm -rf $PKG +mkdir -p $TMP $PKG $OUTPUT +cd $TMP +rm -rf $PBIN +tar xvf $CWD/$PBIN.tar.gz +cd $PBIN + +mkdir -p $PKG/usr/{bin,man/man1} +install -m0755 -oroot -groot * $PKG/usr/bin +install -m0644 -oroot -groot $CWD/docs/man/*.? $PKG/usr/man/man1 + +gzip -9 $PKG/usr/man/man?/*.? + +mkdir -p $PKG/usr/doc/$PRGNAM-$VERSION +install -m0644 -oroot -groot $CWD/docs/{README.md,AUTHORS,COPYING,Changelog} \ + $PKG/usr/doc/$PRGNAM-$VERSION +cat $CWD/$PRGNAM.SlackBuild > $PKG/usr/doc/$PRGNAM-$VERSION/$PRGNAM.SlackBuild + +mkdir -p $PKG/install +cat $CWD/slack-desc > $PKG/install/slack-desc + +cd $PKG +/sbin/makepkg -l y -c n $OUTPUT/$PRGNAM-$VERSION-$ARCH-$BUILD$TAG.$PKGTYPE diff --git a/system/kiwix-tools-bin/kiwix-tools-bin.info b/system/kiwix-tools-bin/kiwix-tools-bin.info new file mode 100644 index 0000000000..2a985ed122 --- /dev/null +++ b/system/kiwix-tools-bin/kiwix-tools-bin.info @@ -0,0 +1,10 @@ +PRGNAM="kiwix-tools-bin" +VERSION="3.7.0" +HOMEPAGE="https://kiwix.org" +DOWNLOAD="https://download.kiwix.org/release/kiwix-tools/kiwix-tools_linux-i586-3.7.0.tar.gz" +MD5SUM="7c8fc641b35f10dddeccea2703aea483" +DOWNLOAD_x86_64="https://download.kiwix.org/release/kiwix-tools/kiwix-tools_linux-x86_64-3.7.0.tar.gz" +MD5SUM_x86_64="1229661b3aca871070c782544063c7f6" +REQUIRES="" +MAINTAINER="G. Galdini" +EMAIL="jake@dioniso.com.br" diff --git a/system/kiwix-tools-bin/slack-desc b/system/kiwix-tools-bin/slack-desc new file mode 100644 index 0000000000..17b9651bb4 --- /dev/null +++ b/system/kiwix-tools-bin/slack-desc @@ -0,0 +1,19 @@ +# HOW TO EDIT THIS FILE: +# The "handy ruler" below makes it easier to edit a package description. +# Line up the first '|' above the ':' following the base package name, and +# the '|' on the right side marks the last column you can put a character in. +# You must make exactly 11 lines for the formatting to be correct. It's also +# customary to leave one space after the ':' except on otherwise blank lines. + + |-----handy-ruler------------------------------------------------------| +kiwix-tools-bin: kiwix-tools-bin (offline access for Wikipedia) +kiwix-tools-bin: +kiwix-tools-bin: Kiwix enables you to have the whole Wikipedia at hand wherever you +kiwix-tools-bin: go! On a boat, in the middle of nowhere or in Jail, Kiwix gives you +kiwix-tools-bin: access to the whole human knowledge. You don't need Internet, +kiwix-tools-bin: everything is stored on your computer, USB flash drive or DVD! +kiwix-tools-bin: +kiwix-tools-bin: Homepage: https://kiwix.org +kiwix-tools-bin: +kiwix-tools-bin: +kiwix-tools-bin: -- cgit v1.2.3