commit 638306420c16707a4e6340bd5aa655f907a0d2b9
parent 57a7881cd9308a6bac6d3713268ab3ef6b314ade
Author: afify <hassan@afify.dev>
Date: Wed, 23 Sep 2020 00:27:03 +0300
[doc] update LICENSE, README, man page
Diffstat:
3 files changed, 38 insertions(+), 13 deletions(-)
diff --git a/LICENSE b/LICENSE
@@ -1,6 +1,7 @@
ISC License
© 2020 Hassan Afify <hassan at afify dot dev>
+© 2020 Mohamed Afify <mohamed at afify dot dev>
Permission to use, copy, modify, and distribute this software for any
purpose with or without fee is hereby granted, provided that the above
diff --git a/README.md b/README.md
@@ -1,18 +1,16 @@
-**simple file manager for unix-like systems**
+**simple file manager**
[](https://lgtm.com/projects/g/afify/sfm/context:cpp)
[](https://ci.appveyor.com/project/afify/sfm)
[](https://github.com/afify/sfm/blob/master/LICENSE)
-Features
---------
-* No dependencies, static linking of [termbox](https://github.com/nsf/termbox).
-* Fast, minimal, lightweight, c99.
-* Open files (videos, images, ...).
-* Bookmarks.
-* Vim keys navigation.
+Description
+------------
+sfm is a simple file manager for unix-like systems based on [termbox](https://github.com/nsf/termbox).
+dual pane, bottom statusbar, bookmarks, open files by extention, vim-like key bindings as default configuration. cwd is left pane dir. No dependencies, static linking, c99.
+
* Inspired by [vifm](https://vifm.info/) and [noice](https://git.2f30.org/noice/).
* Follows the suckless [philosophy](https://suckless.org/philosophy/) and [code style](https://suckless.org/coding_style/).
@@ -25,6 +23,7 @@ $ sfm [-v]
$ man sfm
```
+**normal mode**
| key | description |
|:---------|:--------------------|
| `q` | quit |
@@ -34,6 +33,7 @@ $ man sfm
| `l` | open |
| `g` | top |
| `G` | bottom |
+| `M` | middle |
| `ctrl+u` | scroll up |
| `ctrl+d` | scroll down |
| `n` | create new file |
@@ -44,6 +44,14 @@ $ man sfm
| `ESC` | exit filter |
| `SPACE` | switch pane |
+**visual mode**
+| key | description |
+|:---------|:--------------------|
+| `v` | enter visual mode |
+| `j` | select down |
+| `k` | select up |
+| `ESC` | exit visual mode |
+
Installation
------------
**current**
diff --git a/sfm.1 b/sfm.1
@@ -6,13 +6,14 @@ sfm \- simple file manager
.RB [ \-v ]
.SH DESCRIPTION
sfm is a simple file manager for unix-like systems based on termbox.
-dual panes, bottom statusbar, bookmarks, open files by extention, vim-like key bindings as default configuration. current directory is left pane default directory.
+dual panes, bottom statusbar, bookmarks, open files by extention, vim-like key bindings as default configuration. cwd is left pane dir.
.P
.SH OPTIONS
.TP
.B \-v
print version.
.SH USAGE
+.SS Normal Mode
.TP
.B q
quit
@@ -42,7 +43,7 @@ scroll up
scroll down
.TP
.B n
-create new file if not exists (perm = 600)
+create new file if not exists
.TP
.B N
create new directory if not exists
@@ -61,6 +62,19 @@ exit filter
.TP
.B SPACE
switch pane
+.SS Visual Mode
+.TP
+.B v
+enter visual mode
+.TP
+.B j
+select down
+.TP
+.B k
+select up
+.TP
+.B ESC
+exit visual mode
.SH CUSTOMIZATION
sfm is customized by creating a custom
.IR config.h
@@ -69,9 +83,11 @@ code. This keeps it fast, secure and simple.
.SH ENVIRONMENT
.TP
.B EDITOR
-used to open any file with unconfigured extention. use vi(1) if not set.
+open unconfigured file extention. vi(1) if not set.
.TP
.B HOME
-right pane default directory, go to / if not set.
+right pane default directory. / if not set.
.SH AUTHORS
-Hassan Afify <hassan at afify dot dev>
+See the LICENSE file for the authors.
+.SH LICENSE
+See the LICENSE file for the terms of redistribution.
