GopherProxy

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