Introduction
Introduction Statistics Contact Development Disclaimer Help
Fix mistakes in man page using mandoc -Tlint validator - notes - a console note…
Log
Files
Refs
Tags
LICENSE
---
commit f85c42c86d300ca7c0ae06e0a7fe90dfa00996dd
parent f7e73487c7dd40d2589d1797bacfb023e57ae722
Author: Solene Rapenne <[email protected]>
Date: Mon, 1 Jul 2019 19:43:54 +0200
Fix mistakes in man page using mandoc -Tlint validator
Diffstat:
M notes.1 | 72 ++++++++++++++++-------------…
1 file changed, 36 insertions(+), 36 deletions(-)
---
diff --git a/notes.1 b/notes.1
@@ -13,40 +13,35 @@
is a shell script to ease plain-text notes taking and keeping history of editi…
.Pp
.Nm
-helps working on plain text files inside a directory versioned with git. It pr…
-to display last modified files, history of a file, start a text editor for edi…
+helps working on plain text files inside a directory versioned with git.
+It provides commands to display last modified files, history of a file,
+start a text editor for editing.
+Every time
.Nm
is called to edit a file, changes are commited.
-.Pp
.Sh COMMANDS
.Bl -tag -width Ds
-.It Nm Cm Op ls
-Show the repository tree with colours using
-.Xr colortree 1
-if the command is available or fallback to a simple file list.
+.It Nm Op ls
+Show the repository tree as a file list.
.It Nm Oo edit Oc file
execute $EDITOR on
.Ar file
and then call
.Xr git 1
-to commit the changes on this file. The commit message is always
+to commit the changes on this file.
+The commit message is always
.Ql Edited by $USER
-
-If $EDITOR is not sets,
+.sp
+If $EDITOR is not sets,
.Nm
-will try to find the first editor available using the command
-.Xr type
-in the following order:
-.Xr nvim 1
-,
-.Xr vim 1
-,
-.Xr emacs 1
-,
+will try to find the first editor available using the command type in the foll…
+.Xr nvim 1 ,
+.Xr vim 1 ,
+.Xr emacs 1 ,
.Xr vi 1
and will default to
.Xr ed 1 if none of the previous is found.
-
+.sp
The edit parameter can be used if you need to edit a file which name correspon…
.Nm
single argument command like in
@@ -57,17 +52,18 @@ Display the content of
on standard output.
.It Nm Cm history Ar file
Execute
-.Xr tig 1
+.Xr tig 1
on
.Ar file
to display commit history.
.It Nm Cm last Op limit
-display files and their last commit time ordered by time. If
+display files and their last commit time ordered by time.
+If
.Ar limit
is passed, only
.Ar limit
lines are displayed.
-
+.sp
This is useful to find which files have been modified lastly.
.It Nm Cm init
Initialise the git repository using the command
@@ -79,34 +75,38 @@ delete
.Ar file
and commit the deletion within git.
.It Nm Cm _list Op path
-return a raw list of files. This has been made to provide a file list for shel…
-
+return a raw list of files.
+This has been made to provide a file list for shell completion.
If
.Ar path
-is set, then only files inside the path will be displayed. This can be useful …
+is set, then only files inside the path will be displayed.
+This can be useful if you want only
one folder from your tree.
-.Sh FILES
-.Bl -tag -width "~/notes" -compact
-.It Pa ~/notes
-default directory where
-.Nm
-will create a git repository.
+.El
.Sh ENVIRONMENT
.Bl -tag -width EDITOR
.It Ev REPO
The directory where
.Nm
-will work from. It will override the default directory or allows to takes
+will work from.
+It will override the default directory or allows to takes
notes in different repositories.
.It Ev EDITOR
The location of the text editor used by
.Nm
-.Sh EXIT
+.El
+.Sh FILES
+.Bl -tag -width "~/notes" -compact
+.It Pa ~/notes
+default directory where
+.Nm
+will create a git repository.
+.El
+.Sh EXIT
.Ex -std notes
.Sh SEE ALSO
-.Xr git 1
+.Xr git 1 ,
.Xr tig 1
-.Xr colortree 1
.Sh Authors
.An -nosplit
The
You are viewing proxied material from bitreich.org. The copyright of proxied material belongs to its original authors. Any comments or complaints in relation to proxied material should be directed to the original authors of the content concerned. Please see the disclaimer for more details.