inotes.1 - 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 inotes.1 (2507B) Err bitreich.org 70 i--- Err bitreich.org 70 i 1 .Dd $Mdocdate: July 13 2018 $ Err bitreich.org 70 i 2 .Dt NOTES 1 Err bitreich.org 70 i 3 .Os Err bitreich.org 70 i 4 .Sh NAME Err bitreich.org 70 i 5 .Nm notes Err bitreich.org 70 i 6 .Nd a console notes manager using git Err bitreich.org 70 i 7 .Sh SYNOPSIS Err bitreich.org 70 i 8 .Nm notes Err bitreich.org 70 i 9 .Op command Err bitreich.org 70 i 10 .Op file Err bitreich.org 70 i 11 .Sh DESCRIPTION Err bitreich.org 70 i 12 .Nm Err bitreich.org 70 i 13 is a shell script to ease plain-text notes taking and keeping history of editions with git. Err bitreich.org 70 i 14 .Pp Err bitreich.org 70 i 15 .Nm Err bitreich.org 70 i 16 helps working on plain text files inside a directory versioned with git. Err bitreich.org 70 i 17 It provides commands to display last modified files, history of a file, Err bitreich.org 70 i 18 start a text editor for editing. Err bitreich.org 70 i 19 Every time Err bitreich.org 70 i 20 .Nm Err bitreich.org 70 i 21 is called to edit a file, changes are commited. Err bitreich.org 70 i 22 .Sh COMMANDS Err bitreich.org 70 i 23 .Bl -tag -width Ds Err bitreich.org 70 i 24 .It Nm Op ls Err bitreich.org 70 i 25 Show the repository tree as a file list. Err bitreich.org 70 i 26 .It Nm Oo edit Oc file Err bitreich.org 70 i 27 execute $EDITOR on Err bitreich.org 70 i 28 .Ar file Err bitreich.org 70 i 29 and then call Err bitreich.org 70 i 30 .Xr git 1 Err bitreich.org 70 i 31 to commit the changes on this file. Err bitreich.org 70 i 32 The commit message is always Err bitreich.org 70 i 33 .Ql Edited by $USER Err bitreich.org 70 i 34 .sp Err bitreich.org 70 i 35 If $EDITOR is not sets, Err bitreich.org 70 i 36 .Nm Err bitreich.org 70 i 37 will try to find the first editor available using the command type in the following order: Err bitreich.org 70 i 38 .Xr nvim 1 , Err bitreich.org 70 i 39 .Xr vim 1 , Err bitreich.org 70 i 40 .Xr emacs 1 , Err bitreich.org 70 i 41 .Xr vi 1 Err bitreich.org 70 i 42 and will default to Err bitreich.org 70 i 43 .Xr ed 1 if none of the previous is found. Err bitreich.org 70 i 44 .sp Err bitreich.org 70 i 45 The edit parameter can be used if you need to edit a file which name correspond to a Err bitreich.org 70 i 46 .Nm Err bitreich.org 70 i 47 single argument command like in Err bitreich.org 70 i 48 .Ql notes edit last Err bitreich.org 70 i 49 .It Nm Cm cat Ar file Err bitreich.org 70 i 50 Display the content of Err bitreich.org 70 i 51 .Ar file Err bitreich.org 70 i 52 on standard output. Err bitreich.org 70 i 53 .It Nm Cm history Ar file Err bitreich.org 70 i 54 Execute Err bitreich.org 70 i 55 .Xr tig 1 Err bitreich.org 70 i 56 on Err bitreich.org 70 i 57 .Ar file Err bitreich.org 70 i 58 to display commit history. Err bitreich.org 70 i 59 .It Nm Cm last Op limit Err bitreich.org 70 i 60 display files and their last commit time ordered by time. Err bitreich.org 70 i 61 If Err bitreich.org 70 i 62 .Ar limit Err bitreich.org 70 i 63 is passed, only Err bitreich.org 70 i 64 .Ar limit Err bitreich.org 70 i 65 lines are displayed. Err bitreich.org 70 i 66 .sp Err bitreich.org 70 i 67 This is useful to find which files have been modified lastly. Err bitreich.org 70 i 68 .It Nm Cm init Err bitreich.org 70 i 69 Initialise the git repository using the command Err bitreich.org 70 i 70 .Ql git --init Err bitreich.org 70 i 71 .It Nm Cm help Err bitreich.org 70 i 72 display the usage help Err bitreich.org 70 i 73 .It Nm Cm rm Ar file Err bitreich.org 70 i 74 delete Err bitreich.org 70 i 75 .Ar file Err bitreich.org 70 i 76 and commit the deletion within git. Err bitreich.org 70 i 77 .It Nm Cm _list Op path Err bitreich.org 70 i 78 return a raw list of files. Err bitreich.org 70 i 79 This has been made to provide a file list for shell completion. Err bitreich.org 70 i 80 If Err bitreich.org 70 i 81 .Ar path Err bitreich.org 70 i 82 is set, then only files inside the path will be displayed. Err bitreich.org 70 i 83 This can be useful if you want only Err bitreich.org 70 i 84 one folder from your tree. Err bitreich.org 70 i 85 .El Err bitreich.org 70 i 86 .Sh ENVIRONMENT Err bitreich.org 70 i 87 .Bl -tag -width EDITOR Err bitreich.org 70 i 88 .It Ev REPO Err bitreich.org 70 i 89 The directory where Err bitreich.org 70 i 90 .Nm Err bitreich.org 70 i 91 will work from. Err bitreich.org 70 i 92 It will override the default directory or allows to takes Err bitreich.org 70 i 93 notes in different repositories. Err bitreich.org 70 i 94 .It Ev EDITOR Err bitreich.org 70 i 95 The location of the text editor used by Err bitreich.org 70 i 96 .Nm Err bitreich.org 70 i 97 .El Err bitreich.org 70 i 98 .Sh FILES Err bitreich.org 70 i 99 .Bl -tag -width "~/notes" -compact Err bitreich.org 70 i 100 .It Pa ~/notes Err bitreich.org 70 i 101 default directory where Err bitreich.org 70 i 102 .Nm Err bitreich.org 70 i 103 will create a git repository. Err bitreich.org 70 i 104 .El Err bitreich.org 70 i 105 .Sh EXIT Err bitreich.org 70 i 106 .Ex -std notes Err bitreich.org 70 i 107 .Sh SEE ALSO Err bitreich.org 70 i 108 .Xr git 1 , Err bitreich.org 70 i 109 .Xr tig 1 Err bitreich.org 70 i 110 .Sh Authors Err bitreich.org 70 i 111 .An -nosplit Err bitreich.org 70 i 112 The Err bitreich.org 70 i 113 .Nm Err bitreich.org 70 i 114 program was written by Err bitreich.org 70 i 115 .An Solène Rapenne Aq Mt solene@perso.pw Err bitreich.org 70 i 116 with contributions from Err bitreich.org 70 i 117 .An Quentin Rameau Err bitreich.org 70 .