nsxiv348707a
Added section "Additional features" to README.md
+30 −3
1 file changed
- M README.md +30 −3
| @@ -8,7 +8,7 @@ Its code base should be kept small and clean to make it easy for you to dig | |||
| 8 | 8 | into it and customize it for your needs. | |
| 9 | 9 | ||
| 10 | 10 | Installation | |
| 11 | − | ------------ | |
| 11 | + | ============ | |
| 12 | 12 | sxiv is built using the commands: | |
| 13 | 13 | ||
| 14 | 14 | $ make | |
| @@ -21,13 +21,40 @@ of the executable will be "/usr/local/bin/sxiv". | |||
| 21 | 21 | You can install it into a directory of your choice by changing the second | |
| 22 | 22 | command to: | |
| 23 | 23 | ||
| 24 | − | # PREFIX="/your/dir" make install | |
| 24 | + | # make PREFIX="/your/dir" install | |
| 25 | 25 | ||
| 26 | 26 | All build-time specific settings can be found in the file "config.h". Please | |
| 27 | 27 | check and change them, so that they fit your needs. | |
| 28 | 28 | ||
| 29 | + | Additional features | |
| 30 | + | ------------------- | |
| 31 | + | ||
| 32 | + | The XFLAGS and XLIBS macros/environment variables control which additional | |
| 33 | + | features (i.e. non-default compile-time features) should be enabled and | |
| 34 | + | included during compilation. | |
| 35 | + | ||
| 36 | + | The following table lists the available additional features--the column | |
| 37 | + | *Requires* indicates, which libraries need to be installed for a feature; the | |
| 38 | + | columns *XFLAGS* and *XLIBS* show, what needs to be added to these environment | |
| 39 | + | variables to enable the corresponding feature: | |
| 40 | + | ||
| 41 | + | Feature | Requires | XFLAGS | XLIBS | |
| 42 | + | ----------------------------------+----------+----------------+-------- | |
| 43 | + | GIF support: Load all frames and | giflib | -DGIF_SUPPORT | -lgif | |
| 44 | + | play animations of GIF files | | | | |
| 45 | + | ----------------------------------+----------+----------------+-------- | |
| 46 | + | EXIF support: auto-orientate JPEG | libexif | -DEXIF_SUPPORT | -lexif | |
| 47 | + | files according to their EXIF tag | | | | |
| 48 | + | ||
| 49 | + | For instance, to enable GIF support, the giflib library needs to be installed | |
| 50 | + | on your system and you need to execute the following shell commands before | |
| 51 | + | running make: | |
| 52 | + | ||
| 53 | + | $ export XFLAGS=-DGIF_SUPPORT | |
| 54 | + | $ export XLIBS=-lgif | |
| 55 | + | ||
| 29 | 56 | Usage | |
| 30 | − | ----- | |
| 57 | + | ===== | |
| 31 | 58 | sxiv has two modes of operation: image and thumbnail mode. The default is image | |
| 32 | 59 | mode, in which only the current image is shown. In thumbnail mode a grid of | |
| 33 | 60 | small previews is displayed, making it easy to choose an image to open. | |