mirror of https://codeberg.org/nsxiv/nsxiv
make the gh-pages redirect to codeberg (#304)
NRK
2 years ago
parent
cdb7029fed
commit
f667e1a32d
Binary file not shown.
|
Before Width: | Height: | Size: 5.7 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 140 B |
Binary file not shown.
|
Before Width: | Height: | Size: 374 KiB |
@ -1,227 +1,5 @@
|
||||
<!DOCTYPE html>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<title>nsxiv - Neo Simple X Image Viewer</title>
|
||||
<link rel="stylesheet" href="style.css"><link rel="icon" type="image/png" href="https://raw.githubusercontent.com/nsxiv/nsxiv/master/icon/16x16.png" sizes="16x16"></head>
|
||||
<meta charset="utf-8"/>
|
||||
<meta name="viewport" content="width=device-width">
|
||||
<base href="https://github.com/nsxiv/nsxiv/blob/master/" target="_self">
|
||||
</head>
|
||||
<body><p><a href="https://github.com/nsxiv/nsxiv"><img src="https://raw.githubusercontent.com/nsxiv/nsxiv/gh-pages/img/logo.png" alt="nsxiv" /></a></p>
|
||||
|
||||
<p><a href="https://github.com/nsxiv/nsxiv/tags"><img src="https://img.shields.io/github/v/tag/nsxiv/nsxiv?style=flat-square" alt="tags" /></a>
|
||||
<a href="https://github.com/nsxiv/nsxiv/blob/master/LICENSE"><img src="https://img.shields.io/badge/license-GPL--2.0-lightgreen?style=flat-square" alt="license" /></a>
|
||||
<a href="https://github.com/nsxiv/nsxiv"><img src="https://img.shields.io/tokei/lines/github/nsxiv/nsxiv?color=red&style=flat-square" alt="loc" /></a></p>
|
||||
|
||||
<p><a href="https://nsxiv.github.io/nsxiv/man">View Man Page</a></p>
|
||||
<h2 id="neo-or-new-or-not-simple-or-small-or-suckless-x-image-viewer"><strong>Neo (or New or Not) Simple (or Small or Suckless) X Image Viewer</strong></h2>
|
||||
|
||||
<p>nsxiv is a fork of now unmaintained <a href="https://github.com/muennich/sxiv">sxiv</a>
|
||||
with the purpose of being a drop-in replacement of sxiv, maintaining it and
|
||||
adding simple, sensible features. nsxiv is free software licensed under GPLv2
|
||||
and aims to be easy to modify and customize.</p>
|
||||
|
||||
<p>Please file a bug report if something does not work as documented or
|
||||
expected in <em>this</em> repository, after making sure you are using the latest
|
||||
release of nsxiv. Contributions are welcome, see
|
||||
<a href="CONTRIBUTING.md#Contribution-Guideline">CONTRIBUTING.md</a> for details.</p>
|
||||
|
||||
<h2 id="features">Features</h2>
|
||||
|
||||
<ul>
|
||||
<li>Basic image operations, e.g. zooming, panning, rotating</li>
|
||||
<li>Customizable key and mouse button mappings (in <em>config.h</em>)</li>
|
||||
<li>Script-ability via <code>key-handler</code></li>
|
||||
<li>Thumbnail mode: grid of selectable previews of all images</li>
|
||||
<li>Ability to cache thumbnails for fast re-loading</li>
|
||||
<li>Basic support for animated/multi-frame images (GIF/WebP)</li>
|
||||
<li>Display image information in status bar</li>
|
||||
<li>Display image name/path in X title</li>
|
||||
</ul>
|
||||
|
||||
<h2 id="screenshots">Screenshots</h2>
|
||||
|
||||
<p><strong>Image mode: (Default colors)</strong></p>
|
||||
|
||||
<p><img src="https://raw.githubusercontent.com/nsxiv/nsxiv/gh-pages/img/image.png" alt="Image" title="Image mode" /></p>
|
||||
|
||||
<p><strong>Thumbnail mode: (Custom colors)</strong></p>
|
||||
|
||||
<p><img src="https://raw.githubusercontent.com/nsxiv/nsxiv/gh-pages/img/thumb.png" alt="Thumb" title="Thumb mode" /></p>
|
||||
|
||||
<h2 id="installing-via-package-manager">Installing via package manager</h2>
|
||||
|
||||
<p>nsxiv is available on the following distributions/repositories. If you don’t see
|
||||
your distro listed here, either contact your distro’s package maintainer or
|
||||
consider packaging it yourself and adding it to the respective community repo.</p>
|
||||
|
||||
<p><a href="https://repology.org/project/nsxiv/versions"><img src="https://repology.org/badge/vertical-allrepos/nsxiv.svg" alt="Packaging status" /></a></p>
|
||||
|
||||
<p>Repos not tracked by repology:</p>
|
||||
|
||||
<ul>
|
||||
<li>Fedora: Enable the copr repo via <code>dnf copr enable mamg22/nsxiv</code>.</li>
|
||||
</ul>
|
||||
|
||||
<h2 id="dependencies">Dependencies</h2>
|
||||
|
||||
<p>nsxiv requires the following software to be installed:</p>
|
||||
|
||||
<ul>
|
||||
<li>Imlib2</li>
|
||||
<li>X11</li>
|
||||
</ul>
|
||||
|
||||
<p>The following dependencies are optional.</p>
|
||||
|
||||
<ul>
|
||||
<li>inotify : Used for auto-reloading images on change.
|
||||
Disabled via <code>HAVE_INOTIFY=0</code></li>
|
||||
<li>libXft, freetype2, fontconfig : Used for the status bar.
|
||||
Disabled via <code>HAVE_LIBFONTS=0</code></li>
|
||||
<li>giflib : Used for animated gif playback.
|
||||
Disabled via <code>HAVE_LIBGIF=0</code>.</li>
|
||||
<li>libexif : Used for auto-orientation and exif thumbnails.
|
||||
Disable via <code>HAVE_LIBEXIF=0</code></li>
|
||||
<li>libwebp : Used for animated webp playback.
|
||||
(NOTE: animated webp also requires Imlib2 v1.7.5 or above)
|
||||
Disabled via <code>HAVE_LIBWEBP=0</code>.</li>
|
||||
</ul>
|
||||
|
||||
<p>Please make sure to install the corresponding development packages in case that
|
||||
you want to build nsxiv on a distribution with separate runtime and development
|
||||
packages (e.g. *-dev on Debian).</p>
|
||||
|
||||
<h2 id="building">Building</h2>
|
||||
|
||||
<p>nsxiv is built using the commands:</p>
|
||||
|
||||
<pre><code>$ make
|
||||
</code></pre>
|
||||
|
||||
<p>You can pass <code>HAVE_X=0</code> to <code>make</code> to disable an optional dependency.
|
||||
For example:</p>
|
||||
|
||||
<pre><code>$ make HAVE_LIBEXIF=0
|
||||
</code></pre>
|
||||
|
||||
<p>will disable <code>libexif</code> support. Alternatively they can be disabled via editing
|
||||
the <code>Makefile</code> directly. <code>OPT_DEP_DEFAULT=0</code> can be used to disable all
|
||||
optional dependencies.</p>
|
||||
|
||||
<p>Installing nsxiv:</p>
|
||||
|
||||
<pre><code># make install
|
||||
</code></pre>
|
||||
|
||||
<p>Installing desktop entry:</p>
|
||||
|
||||
<pre><code># make install-desktop
|
||||
</code></pre>
|
||||
|
||||
<p>Installing icons:</p>
|
||||
|
||||
<pre><code># make install-icon
|
||||
</code></pre>
|
||||
|
||||
<p>Installing all of the above:</p>
|
||||
|
||||
<pre><code># make install-all
|
||||
</code></pre>
|
||||
|
||||
<p>Please note, that these requires root privileges.
|
||||
By default, nsxiv is installed using the prefix <code>/usr/local</code>, so the full path
|
||||
of the executable will be <code>/usr/local/bin/nsxiv</code>, the <code>.desktop</code> entry will be
|
||||
<code>/usr/local/share/applications/nsxiv.desktop</code> and the icon path will be
|
||||
<code>/usr/local/share/icons/hicolor/{size}/apps/nsxiv.png</code>.</p>
|
||||
|
||||
<p>You can install nsxiv into a directory of your choice by changing this command to:</p>
|
||||
|
||||
<pre><code>$ make PREFIX="/your/dir" install
|
||||
</code></pre>
|
||||
|
||||
<p>Example scripts are installed using <code>EGPREFIX</code> which defaults to
|
||||
<code>/usr/local/share/doc/nsxiv/examples</code>. You can change <code>EGPREFIX</code> the same way
|
||||
you can change <code>PREFIX</code> shown above.</p>
|
||||
|
||||
<p>The build-time specific settings of nsxiv can be found in the file <em>config.h</em>.
|
||||
Please check and change them, so that they fit your needs.
|
||||
If the file <em>config.h</em> does not already exist, then you have to create it with
|
||||
the following command:</p>
|
||||
|
||||
<pre><code>$ make config.h
|
||||
</code></pre>
|
||||
|
||||
<h2 id="usage">Usage</h2>
|
||||
|
||||
<p>Please see man page for information on how to use nsxiv. To do so, execute the
|
||||
following after the installation:</p>
|
||||
|
||||
<pre><code>$ man nsxiv
|
||||
</code></pre>
|
||||
|
||||
<h2 id="f.a.q">F.A.Q</h2>
|
||||
|
||||
<ul>
|
||||
<li><p>Can I open remote urls with nsxiv?
|
||||
Yes, see <a href="https://github.com/nsxiv/nsxiv-extra/tree/master/scripts/nsxiv-url">nsxiv-url</a></p></li>
|
||||
<li><p>Can I open all the images in a directory?
|
||||
Yes, see <a href="https://github.com/nsxiv/nsxiv-extra/tree/master/scripts/nsxiv-rifle">nsxiv-rifle</a></p></li>
|
||||
<li><p>Can I set default arguments for nsxiv?
|
||||
Yes, see <a href="https://github.com/nsxiv/nsxiv-extra/tree/master/scripts/nsxiv-env">nsxiv-env</a></p></li>
|
||||
<li><p>Can I pipe images into nsxiv?
|
||||
Yes, see <a href="https://github.com/nsxiv/nsxiv-extra/tree/master/scripts/nsxiv-pipe">nsxiv-pipe</a></p></li>
|
||||
<li><p>nsxiv crashes when viewing images with emojis in their name.
|
||||
This is an issue with libXft. Either wait for
|
||||
<a href="https://gitlab.freedesktop.org/xorg/lib/libxft/-/merge_requests/1">this</a> fix to
|
||||
be merged, or install <a href="https://github.com/uditkarode/libxft-bgra">libxft-bgra</a></p></li>
|
||||
</ul>
|
||||
|
||||
<h2 id="customization">Customization</h2>
|
||||
|
||||
<p>The main method of customizing nsxiv is by setting values for the variables in <em>config.h</em>,
|
||||
or by using Xresources as explained in the manual. If these options are not sufficient,
|
||||
you may implement your own features by following
|
||||
<a href="https://github.com/nsxiv/nsxiv-extra/blob/master/CUSTOMIZATION.md">this guide</a>.</p>
|
||||
|
||||
<p>Due to our limited <a href="CONTRIBUTING.md#Project-Scope">project scope</a>, certain features or
|
||||
customization cannot be merged into nsxiv mainline. Following the spirit of suckless
|
||||
software, we host the <a href="https://github.com/nsxiv/nsxiv-extra">nsxiv-extra</a> repo where users
|
||||
are free to submit whatever patches or scripts they wish.</p>
|
||||
|
||||
<p>If you think your custom features can be beneficial for the general user base and is within
|
||||
our project scope, please submit it as a pull request on this repository, then we <em>may</em>
|
||||
merge it to mainline.</p>
|
||||
|
||||
<p>Description on how to use or submit patches can be found on
|
||||
nsxiv-extra’s <a href="https://github.com/nsxiv/nsxiv-extra">README</a>.</p>
|
||||
|
||||
<h2 id="download">Download</h2>
|
||||
|
||||
<p>You can <a href="https://github.com/nsxiv/nsxiv">browse</a> the source code repository
|
||||
on GitHub or get a copy using git with the following command:</p>
|
||||
|
||||
<pre><code>$ git clone https://github.com/nsxiv/nsxiv.git
|
||||
</code></pre>
|
||||
|
||||
<p>You can view the changelog <a href="CHANGELOG.md">here</a></p>
|
||||
|
||||
<h2 id="related-projects">Related projects</h2>
|
||||
|
||||
<p>If nsxiv isn’t able to fit your needs, check out the image viewer section of
|
||||
<a href="https://suckless.org/rocks">suckless rocks</a> to find other minimal image viewers
|
||||
to try out.</p>
|
||||
|
||||
<p>Below are a couple other lesser known projects not listed in suckless rocks.</p>
|
||||
|
||||
<ul>
|
||||
<li><a href="https://github.com/explosion-mental/mage">MAGE</a> :
|
||||
A smaller/more-suckless version of sxiv.</li>
|
||||
<li><a href="https://github.com/TAAPArthur/div">div</a> :
|
||||
Minimal and extensive, aimed at C devs willing to build their own features.</li>
|
||||
<li><a href="https://github.com/occivink/mpv-image-viewer">mpv-image-viewer</a> :
|
||||
Lua script to turn mpv into an image viewer. Supports thumbnails via
|
||||
<a href="https://github.com/occivink/mpv-gallery-view">mpv-gallery-view</a>.</li>
|
||||
</ul>
|
||||
</body>
|
||||
</html>
|
||||
<meta charset="utf-8">
|
||||
<title>Redirecting to https://nsxiv.codeberg.page/</title>
|
||||
<meta http-equiv="refresh" content="0; URL=https://nsxiv.codeberg.page/">
|
||||
<link rel="canonical" href="https://nsxiv.codeberg.page/">
|
||||
|
||||
File diff suppressed because it is too large
Load Diff
@ -1,71 +0,0 @@
|
||||
html {
|
||||
scroll-behavior: smooth;
|
||||
}
|
||||
|
||||
body {
|
||||
font-family: 'monospace';
|
||||
font-weight: 400;
|
||||
line-height: 1.2;
|
||||
font-size: 1.10rem;
|
||||
letter-spacing: 0.20px;
|
||||
word-wrap: break-word;
|
||||
|
||||
max-width: 100ch;
|
||||
padding: 0 1em;
|
||||
margin: auto;
|
||||
|
||||
background-color: #181A1B;
|
||||
color: #E8E6E3;
|
||||
}
|
||||
|
||||
h1, h2, h3 {
|
||||
font-family: 'sans-serif';
|
||||
font-size: 150%;
|
||||
font-weight: 600;
|
||||
letter-spacing: .07em;
|
||||
margin-top: 1.5em;
|
||||
margin-bottom: .35em;
|
||||
}
|
||||
|
||||
i, code {
|
||||
font-family: monospace;
|
||||
background-color: #2c2d32;
|
||||
padding: .2em .4em;
|
||||
border-radius: 6px;
|
||||
}
|
||||
|
||||
code {
|
||||
margin-top: 15px;
|
||||
padding: 3px 3px;
|
||||
display: block;
|
||||
}
|
||||
|
||||
p > code, li > code {
|
||||
padding: 4px 4px 2px 4px;
|
||||
display: inline;
|
||||
}
|
||||
|
||||
pre > code {
|
||||
padding: 12px 8px 8px 8px;
|
||||
border: 2px solid #383a3f;
|
||||
border-radius: 2px;
|
||||
white-space: pre-wrap;
|
||||
}
|
||||
|
||||
a {
|
||||
font-family: monospace;
|
||||
text-decoration: none;
|
||||
color: #55A4FF;
|
||||
}
|
||||
|
||||
b {
|
||||
font-family: monospace;
|
||||
font-weight: 700;
|
||||
}
|
||||
|
||||
img {
|
||||
max-width: 100%;
|
||||
box-shadow: 0 4px 8px 0 rgba(0, 0, 0, 0.2), 0 6px 20px 0 rgba(0, 0, 0, 0.19);
|
||||
}
|
||||
|
||||
::selection {color: #c4c4c4; background: #50525b;}
|
||||
@ -1,3 +0,0 @@
|
||||
# Insert man page link *before* the main heading
|
||||
/<h2 id="neo-or-new-or-not-simple-or-small-or-suckless-x-image-viewer"><strong>Neo (or New or Not) Simple (or Small or Suckless) X Image Viewer<\/strong><\/h2>/i\
|
||||
<p><a href="https://nsxiv.github.io/nsxiv/man">View Man Page</a></p>
|
||||
@ -1,10 +0,0 @@
|
||||
<!DOCTYPE html>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<title>nsxiv - Neo Simple X Image Viewer</title>
|
||||
<link rel="stylesheet" href="style.css"><link rel="icon" type="image/png" href="https://raw.githubusercontent.com/nsxiv/nsxiv/master/icon/16x16.png" sizes="16x16"></head>
|
||||
<meta charset="utf-8"/>
|
||||
<meta name="viewport" content="width=device-width">
|
||||
<base href="https://github.com/nsxiv/nsxiv/blob/master/" target="_self">
|
||||
</head>
|
||||
<body>
|
||||
@ -1,2 +0,0 @@
|
||||
</body>
|
||||
</html>
|
||||
@ -1,15 +0,0 @@
|
||||
#!/bin/sh
|
||||
|
||||
# Dependencies: cat, lowdown, groff
|
||||
|
||||
#Mainpage
|
||||
cat template/template-1.html > index.html
|
||||
git show "master:README.md" | lowdown | sed -f template/changes.sed >> index.html
|
||||
cat template/template-2.html >> index.html
|
||||
|
||||
#Manpage
|
||||
css='<link rel="stylesheet" href="../style.css">'
|
||||
icon_src='https://raw.githubusercontent.com/nsxiv/nsxiv/master/icon/16x16.png'
|
||||
icon='<link rel="icon" type="image/png" href="'"$icon_src"'" sizes="16x16">'
|
||||
|
||||
git show "master:nsxiv.1" | groff -mandoc -Thtml | sed 's|^</head>|'"${css}${icon}"'</head>|' > man/index.html
|
||||
Loading…
Reference in New Issue