idraft of man page - notes - a console notes manager using git Err bitreich.org 70
1Log /scm/notes/log.gph bitreich.org 70
1Files /scm/notes/files.gph bitreich.org 70
1Refs /scm/notes/refs.gph bitreich.org 70
1Tags /scm/notes/tag bitreich.org 70
1LICENSE /scm/notes/file/LICENSE.gph bitreich.org 70
i--- Err bitreich.org 70
1commit b3e4fc2cc7cae09643d83da834b3ee37b1274503 /scm/notes/commit/b3e4fc2cc7cae09643d83da834b3ee37b1274503.gph bitreich.org 70
1parent 117a7f897c43230a75c3dc3ebb00bd38b6be5d49 /scm/notes/commit/117a7f897c43230a75c3dc3ebb00bd38b6be5d49.gph bitreich.org 70
hAuthor: Solene Rapenne <solene@perso.pw> URL:mailto:solene@perso.pw bitreich.org 70
iDate: Fri, 13 Jul 2018 20:03:09 +0200 Err bitreich.org 70
i Err bitreich.org 70
idraft of man page Err bitreich.org 70
i Err bitreich.org 70
iDiffstat: Err bitreich.org 70
i A notes.1 | 92 +++++++++++++++++++++++++++++++ Err bitreich.org 70
i Err bitreich.org 70
i1 file changed, 92 insertions(+), 0 deletions(-) Err bitreich.org 70
i--- Err bitreich.org 70
1diff --git a/notes.1 b/notes.1 /scm/notes/file/notes.1.gph bitreich.org 70
i@@ -0,0 +1,92 @@ Err bitreich.org 70
i+.Dd $Mdocdate: July 13 2018 $ Err bitreich.org 70
i+.Dt NOTES 1 Err bitreich.org 70
i+.Os Err bitreich.org 70
i+.Sh NAME Err bitreich.org 70
i+.Nm notes Err bitreich.org 70
i+.Nd a console notes manager using git Err bitreich.org 70
i+.Sh SYNOPSIS Err bitreich.org 70
i+.Nm notes Err bitreich.org 70
i+.Nm notes Err bitreich.org 70
i+.Op Ar file Err bitreich.org 70
i+.Nm notes Err bitreich.org 70
i+.Op Ar command Op Ar file Err bitreich.org 70
i+.Sh DESCRIPTION Err bitreich.org 70
i+.Nm Err bitreich.org 70
i+is a shell script to ease plain-text notes taking and keeping history of editions with git. Err bitreich.org 70
i+.Pp Err bitreich.org 70
i+.Nm Err bitreich.org 70
i+helps working on plain text files inside a folder versionned with git. It provides commands Err bitreich.org 70
i+to display last modified files, history of a file, start a text editor for editing. Every time Err bitreich.org 70
i+.Nm Err bitreich.org 70
i+is called to edit a file, changes are commited. Err bitreich.org 70
i+.Pp Err bitreich.org 70
i+The following commands are available: Err bitreich.org 70
i+.Bl -tag -width Ds Err bitreich.org 70
i+.It Nm Cm Op ls Err bitreich.org 70
i+Show the repository tree with colours using Err bitreich.org 70
i+.Xr colortree 1 Err bitreich.org 70
i+.It Nm Cm cat Ar file Err bitreich.org 70
i+Display the content of Err bitreich.org 70
i+.Ar file Err bitreich.org 70
i+on standard output Err bitreich.org 70
i+.It Nm Cm history Ar file Err bitreich.org 70
i+Execute Err bitreich.org 70
i+.Xr tig 1 Err bitreich.org 70
i+on Err bitreich.org 70
i+.Ar file Err bitreich.org 70
i+to display commit history. Err bitreich.org 70
i+.It Nm Cm last Err bitreich.org 70
i+display files and their last commit time ordered by time. Err bitreich.org 70
i+ Err bitreich.org 70
i+This is useful to find which files have been modified lastly. Err bitreich.org 70
i+.It Nm Ar file Err bitreich.org 70
i+.It Nm Cm edit Ar file Err bitreich.org 70
i+execute $EDITOR on Err bitreich.org 70
i+.Ar file Err bitreich.org 70
i+and then call Err bitreich.org 70
i+.Xr git 1 Err bitreich.org 70
i+to commit the changes on this file. The commit message is always Err bitreich.org 70
i+.Ql Edited by $USER Err bitreich.org 70
i+ Err bitreich.org 70
i+If $EDITOR is not sets, Err bitreich.org 70
i+.Nm Err bitreich.org 70
i+will try to find the first editor available using Err bitreich.org 70
i+.Xr which 1 Err bitreich.org 70
i+in the following order: Err bitreich.org 70
i+.Xr nvim 1 Err bitreich.org 70
i+, Err bitreich.org 70
i+.Xr vim 1 Err bitreich.org 70
i+, Err bitreich.org 70
i+.Xr emacs 1 Err bitreich.org 70
i+and will default to Err bitreich.org 70
i+.Xr vi 1 if none of the previous is found. Err bitreich.org 70
i+.It Nm Cm init Err bitreich.org 70
i+Initialize the git repository using the command Err bitreich.org 70
i+.Ql git --init Err bitreich.org 70
i+.It Nm Cm help Err bitreich.org 70
i+display the usage help Err bitreich.org 70
i+.It Nm Cm _list Err bitreich.org 70
i+return a raw list of files. This has been made to be run for shell completion. Err bitreich.org 70
i+.It Nm Cm rm Ar file Err bitreich.org 70
i+delete Err bitreich.org 70
i+.Ar file Err bitreich.org 70
i+and commit the deletion within git. Err bitreich.org 70
i+.Sh FILES Err bitreich.org 70
i+.Bl -tag -width "~/notes" -compact Err bitreich.org 70
i+.It Pa ~/notes Err bitreich.org 70
i+default folder where Err bitreich.org 70
i+.Nm Err bitreich.org 70
i+will create a git repository. Err bitreich.org 70
i+.Sh ENVIRONMENT Err bitreich.org 70
i+.Bl -tag -width REPO Err bitreich.org 70
i+.It Ev REPO Err bitreich.org 70
i+The folder where Err bitreich.org 70
i+.Nm Err bitreich.org 70
i+will work from. It will override the default folder or allows to takes Err bitreich.org 70
i+notes in differents repositories. Err bitreich.org 70
i+.Sh EXIT Err bitreich.org 70
i+.Ex -std notes Err bitreich.org 70
i+.Sh SEE ALSO Err bitreich.org 70
i+.Xr git 1 Err bitreich.org 70
i+.Xr colortree 1 Err bitreich.org 70
i+.Xr tig 1 Err bitreich.org 70
.
Response:
text/plain