commit 3b83e3911f911f64b8fb54dec69249b542098728
parent 9a0f87c3186076a2d132c21fd50b32e17ee41224
Author: afify <hassan@afify.dev>
Date: Thu, 9 Jul 2020 10:55:08 +0300
[doc] update README man page
- add n N D keys.
Diffstat:
| M | README.md | | | 33 | ++++++++++++++++++--------------- |
| M | sfm.1 | | | 27 | +++++++++++++++++++++++---- |
2 files changed, 41 insertions(+), 19 deletions(-)
diff --git a/README.md b/README.md
@@ -25,21 +25,24 @@ $ sfm [-v]
$ man sfm
```
-| key | description |
-|---------:|:---------------|
-| `q` | quit |
-| `h` | back |
-| `j` | down |
-| `k` | up |
-| `l` | open |
-| `g` | top |
-| `G` | bottom |
-| `ctrl+u` | scroll up |
-| `ctrl+d` | scroll down |
-| `/` | start filter |
-| `ENTER` | find filter |
-| `ESC` | exit filter |
-| `SPACE` | switch pane |
+| key | description |
+|:---------|:--------------------|
+| `q` | quit |
+| `h` | back |
+| `j` | down |
+| `k` | up |
+| `l` | open |
+| `g` | top |
+| `G` | bottom |
+| `ctrl+u` | scroll up |
+| `ctrl+d` | scroll down |
+| `n` | create new file |
+| `N` | create new dir |
+| `D` | delete file \| dir |
+| `/` | start filter |
+| `ENTER` | find filter |
+| `ESC` | exit filter |
+| `SPACE` | switch pane |
Installation
------------
diff --git a/sfm.1 b/sfm.1
@@ -1,11 +1,12 @@
.TH sfm 1 sfm\-VERSION
.SH NAME
-sfm \- a simple file manager for unix-like systems
+sfm \- simple file manager
.SH SYNOPSIS
.B sfm
.RB [ \-v ]
.SH DESCRIPTION
-sfm is a simple file manager based on termbox.
+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.
.P
.SH OPTIONS
.TP
@@ -26,7 +27,7 @@ down
up
.TP
.B l
-open dir|file
+open dir | file
.TP
.B g
top
@@ -40,6 +41,15 @@ scroll up
.B ctrl+d
scroll down
.TP
+.B n
+create new file if not exists (perm = 600)
+.TP
+.B N
+create new directory if not exists
+.TP
+.B D
+delete file | directory recursively
+.TP
.B /
start filter
.TP
@@ -52,7 +62,16 @@ exit filter
.B SPACE
switch pane
.SH CUSTOMIZATION
-sfm is customized by creating a custom config.h and (re)compiling the source
+sfm is customized by creating a custom
+.IR config.h
+and (re)compiling the source
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.
+.TP
+.B HOME
+right pane default directory, go to / if not set.
.SH AUTHORS
Hassan Afify <hassan at afify dot dev>
