sfm

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

README.md (2185B)


      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 * c99 static linking.
     24 * based on [termbox](https://github.com/nsf/termbox).
     25 * Inspired by [vifm](https://vifm.info/) and [noice](https://git.2f30.org/noice/).
     26 * Follows the suckless [philosophy](https://suckless.org/philosophy/).
     27 
     28 Performance
     29 ------------
     30 ```sh
     31 $ perf stat -r 10 sfm
     32 ```
     33 
     34 Options
     35 -------
     36 ```sh
     37 $ sfm [-v]
     38 $ man sfm
     39 ```
     40 <img src="https://afify.dev/img/sfm_sc.png" alt="sfm screenshot" width="800"/>
     41 
     42 Installation
     43 ------------
     44 **current**
     45 ```sh
     46 git clone git://git.afify.dev/sfm
     47 cd sfm/
     48 make
     49 make install
     50 ```
     51 **latest release**
     52 ```sh
     53 [ "$(uname)" = "Linux" ] && shacmd="sha256sum" grepf="--color=never"|| shacmd="sha256"
     54 latest=$(curl -s https://git.afify.dev/sfm/tags.xml | grep $grepf -m 1 -o "\[v.*\]" | tr -d '[]')
     55 tgz="https://git.afify.dev/sfm/releases/sfm-${latest}.tar.gz"
     56 sha="${tgz}.sha256"
     57 wget "${tgz}"
     58 wget "${sha}"
     59 ${shacmd} -c "sfm-${latest}.tar.gz.sha256" && \
     60 tar -xzf "sfm-${latest}.tar.gz" && cd "sfm-${latest}" && \
     61 make
     62 make install
     63 ```
     64 
     65 Run
     66 ---
     67 ```sh
     68 $ sfm
     69 ```
     70 
     71 Configuration
     72 -------------
     73 The configuration of sfm is done by creating a custom config.h
     74 and (re)compiling the source code. This keeps it fast, secure and simple.