~q3cpma/sxiv-manga-reader

Simple manga reader using a patched sxiv
Switch from GNU make to posix-build
Remove default sxiv options and use -m inconditionally
Silent tar vendor check when tar isn't GNU tar

refs

master
browse  log 

clone

read-only
https://git.sr.ht/~q3cpma/sxiv-manga-reader
read/write
git@git.sr.ht:~q3cpma/sxiv-manga-reader

You can also use your local clone with git send-email.

                sxiv-manga-reader - Simple manga reader
                =======================================

        Description
        -----------

Simple manga reader made from a patched sxiv and a mostly POSIX compliant sh
script (see the Dependencies section for more).


        Features
        --------

* Works with tar/cbt/zip/cbz/rar/cbr/7z/cb7 archives and image directories.
* Loads the next/previous item when reaching past the end/beginning of the
  current one ("roaming" mode).
* Save/resume your position.
* A trivial but necessary tool to do natural sorting on stdin (`natsort`).


        Dependencies
        ------------

In addition to the latest POSIX requirements, you'll need the following at
build time:
    * mktemp -d (present on GNU, *BSD, MacOS, Illumos and Tru64)
    * curl, wget or fetch
    * gunzip
    * tar
    * C99 compiler
    * imlib2 (sxiv)
    * libX11 (sxiv)

and the following at runtime:
    * imlib2 (sxiv)
    * libX11 (sxiv)
    * unzip (optional, for cbz)
    * unrar (optional, for cbr)
    * p7zip (optional, for cb7)
    * tar (optional, for cbt)
    * mktemp -d (present on GNU, *BSD, MacOS, Illumos and Tru64)


        Building and installation
        -------------------------

Build and install to PREFIX=/usr/local:
    $ ./build.sh
    # ./build.sh install

If there's a `config.h` present at the project root, it'll be used by sxiv.


        Documentation
        -------------

+---------------------------------------------------------------------------------+
| NAME                                                                            |
|     sxiv-manga-reader - Read mangas as archives or image directories            |
|                                                                                 |
| SYNOPSIS                                                                        |
|     sxiv-manga-reader [-hr] [-d RESUME_DIR] [-o SXIV_OPTS] ARCHIVE|DIRECTORY... |
|     sxiv-manga-reader [-hR] [-d RESUME_DIR] [-o SXIV_OPTS] -c DIRECTORY         |
|                                                                                 |
| DESCRIPTION                                                                     |
|     In the first mode, read multiple mangas as archives or directories          |
|     containing images. If there's only one argument, reaching past its          |
|     end/start will open the next/previous item and so on (roaming mode).        |
|                                                                                 |
|     In the second mode (-c), consider DIRECTORY as containing mangas in         |
|     the same format as the first mode. Save/resume mode (-r) is                 |
|     automatically enabled by this mode.                                         |
|                                                                                 |
| OPTIONS                                                                         |
|     -c                                                                          |
|         See DESCRIPTION.                                                        |
|                                                                                 |
|     -h                                                                          |
|         Print this help message and exit.                                       |
|                                                                                 |
|     -d RESUME_DIR                                                               |
|         Instead of saving resume state files in the same directory as mangas,   |
|         save them in RESUME_DIR (note: using absolute paths).                   |
|                                                                                 |
|     -o SXIV_OPTS                                                                |
|         Pass these options to sxiv.                                             |
|                                                                                 |
|     -r                                                                          |
|         Enable save/resume mode to save item and page information to resume     |
|         reading later.                                                          |
|                                                                                 |
|     -R                                                                          |
|         Disable save/resume mode.                                               |
|                                                                                 |
+---------------------------------------------------------------------------------+