commit 5daece55941d4f02a40ab821b174527d8073a2f5
parent 29c7b7899ae541d1cd83d3fb141130824513c1ab
Author: Mohamed Aslan <maslan@sce.carleton.ca>
Date: Wed, 3 Dec 2014 17:54:44 -0700
update man page with latest changes.
* command diff
* command ls '-c' flag
* command log '-c', '-f' and '-n' flags
* remove command checkout from the command list
Diffstat:
| M | baseline.1 | | | 46 | ++++++++++++++++++++++++++++++++++++++++++---- |
1 file changed, 42 insertions(+), 4 deletions(-)
diff --git a/baseline.1 b/baseline.1
@@ -20,14 +20,14 @@
.Sh SYNOPSIS
.Nm
.Op Cm add Ar [file or dir]
-.Op Cm branch Fl l | c | s
+.Op Cm branch Fl c | l | s
.Op Cm cat Fl c
-.Op Cm checkout
.Op Cm commit Fl m
+.Op Cm diff
.Op Cm help
.Op Cm init
-.Op Cm log
-.Op Cm ls Fl R
+.Op Cm log Fl c | f | n
+.Op Cm ls Fl c | R
.Op Cm version
.Sh DESCRIPTION
The
@@ -83,13 +83,51 @@ then, will try the EDITOR environmental variable.
otherwise, baseline will complain about missing commit message.
.El
.Pp
+To display a diff or generate a patch between a commit and its parent:
+.Dl $ baseline diff <commit id>
+To display a diff between any two commits:
+.Dl $ baseline diff <commit A id> <commit B id>
+.Pp
To list all commits:
.Dl $ baseline log
+To list all commits starting from a specific commit:
+.Dl $ baseline log -c <commit id>
+To limit the number of commits being displayed:
+.Dl $ baseline log -n <number of commits>
+To format the output of log command:
+.Dl $ baseline log -f <format>
+Currently the log command supports the following specifiers for each commit:
+.Bl -bullet -compact
+.It
+%n: a number representing the order of the commit in the log list.
+.It
+%an: the author's name.
+.It
+%ae: the author's email address.
+.It
+%at: the author's commit timestamp.
+.It
+%cn: the committer's name.
+.It
+%ce: the committer's email address.
+.It
+%ct: the committer's commit timestamp.
+.It
+%m: the commit's message.
+.It
+\&\\n: a new line.
+.It
+\&\\t: a tab space.
+.It
+Any other character will be displayed as it is.
+.El
.Pp
To list files and directories:
.Dl $ baseline ls
To recursively list files and directories:
.Dl $ baseline ls -R
+To list file and directories for a specific commit:
+.Dl $ baseline -c <commit id>
.Pp
To get the content of a certain file written to the stdout:
.Dl $ baseline cat </path/to/file>
