sfm

simple file manager
git clone https://git.afify.dev/sfm.git
Log | Files | Refs | README | LICENSE

README.md (2401B)

      1 <img src="https://afify.dev/img/sfm.png" alt="sfm logo"/>
      2 
      3 **simple file manager**
      4 
      5 [![Language grade: C/C++](https://img.shields.io/lgtm/grade/cpp/g/afify/sfm.svg?logo=lgtm&logoWidth=18)](https://lgtm.com/projects/g/afify/sfm/context:cpp)
      6 [![Build status](https://ci.appveyor.com/api/projects/status/goq88ahjyvtjrui2?svg=true)](https://ci.appveyor.com/project/afify/sfm)
      7 [![code-inspector](https://www.code-inspector.com/project/19656/score/svg)](https://frontend.code-inspector.com/public/project/19656/sfm/dashboard)
      8 [![code-inspector](https://www.code-inspector.com/project/19656/status/svg)](https://frontend.code-inspector.com/public/project/19656/sfm/dashboard)
      9 
     10 Description
     11 ------------
     12 sfm is a simple file manager for unix-like systems.
     13 * pthreads(7) to read events, no timers.
     14 * BSD kqueue(2) - kernel event notification mechanism.
     15 * Linux inotify(7) - monitoring filesystem events.
     16 * dual pane.
     17 * bookmarks.
     18 * open files by extension.
     19 * bottom statusbar.
     20 * vim-like key bindings.
     21 * filter.
     22 * no dependencies.
     23 * based on [termbox](https://github.com/nsf/termbox).
     24 * Inspired by [vifm](https://vifm.info/) and [noice](https://git.2f30.org/noice/).
     25 * Follows the suckless [philosophy](https://suckless.org/philosophy/).
     26 
     27 Patches
     28 -------
     29 [sfm-patches](https://github.com/afify/sfm-patches)
     30 
     31 Performance
     32 ------------
     33 ```sh
     34 $ perf stat -r 10 sfm
     35 ```
     36 
     37 Options
     38 -------
     39 ```sh
     40 $ sfm [-v]
     41 $ man sfm
     42 ```
     43 <img src="https://afify.dev/img/sfm_sc.png" alt="sfm screenshot" width="800"/>
     44 
     45 Installation
     46 ------------
     47 <a href="https://repology.org/project/sfm-afify/versions">
     48     <img src="https://repology.org/badge/vertical-allrepos/sfm-afify.svg" alt="Packaging status">
     49 </a>
     50 
     51 **current**
     52 ```sh
     53 git clone https://git.afify.dev/sfm.git
     54 cd sfm/
     55 make
     56 make install
     57 ```
     58 **latest release**
     59 ```sh
     60 [ "$(uname)" = "Linux" ] && shacmd="sha256sum" grepf="--color=never"|| shacmd="sha256"
     61 latest=$(curl -s https://git.afify.dev/sfm/tags.xml | grep $grepf -m 1 -o "\[v.*\]" | tr -d '[]')
     62 tgz="https://git.afify.dev/sfm/releases/sfm-${latest}.tar.gz"
     63 sha="${tgz}.sha256"
     64 wget "${tgz}"
     65 wget "${sha}"
     66 ${shacmd} -c "sfm-${latest}.tar.gz.sha256" && \
     67 tar -xzf "sfm-${latest}.tar.gz" && cd "sfm-${latest}" && \
     68 make
     69 make install
     70 ```
     71 
     72 Run
     73 ---
     74 ```sh
     75 $ sfm
     76 ```
     77 
     78 Configuration
     79 -------------
     80 The configuration of sfm is done by creating a custom config.h
     81 and (re)compiling the source code. This keeps it fast, secure and simple.