hstr/man/hh.1

61 lines
1.7 KiB
Groff
Raw Normal View History

.TH HH 1
.SH NAME
2014-01-17 11:46:12 +08:00
\fBhh\fR \- shell history suggest box
.SH SYNOPSIS
2014-01-17 11:54:54 +08:00
.B hh [option] [arg1] [arg2]...
.SH DESCRIPTION
.B hh
uses shell history to provide suggest box like functionality
for commands used in the past. By default it parses .bash-history
file that is filtered as you type a command substring. Commands
are not just filtered, but also ordered by a ranking algorithm
that considers number of occurences, length and timestamp. In addition
hh allows removal of commands from history - for instance with a typo or with a sensitive content.
2014-01-17 11:46:12 +08:00
.SH OPTIONNS
.TP
\fB--show-configuration\fR
Show configuration to be added to .bashrc
.SH COMMANDS
.TP
2014-01-17 11:54:54 +08:00
\fBpattern\fR\eC\-u
Type to filter shell history.
.TP
\fBCtrl\-i\fR
Toggle case sensitive search.
.TP
\fBCtrl\-h\fR
2014-01-07 14:17:28 +08:00
Toggle history as provided by shell vs. ranked history ordered by the number of occurences, length and timestamp.
.TP
\fBUP\fR arrow, \fBDOWN\fR arrow
2014-01-07 14:19:10 +08:00
Navigate in the history list.
.TP
\fBENTER\fR
Choose currently selected item for completion.
.TP
\fBCtrl\-r\fR
Remove currently selected item from the shell history.
.TP
\fBCtrl\-x\fR
Write changes to shell history and exit.
.SH INSTALLATION
Add the following lines to ~/.bashrc:
.nf
.sp
shopt -s histappend
export PROMPT_COMMAND="history \-a; history \-n; ${PROMPT_COMMAND}"
2014-01-17 11:46:12 +08:00
bind '"\eC\-r": "\eC\-ahh \eC-j"'
.sp
.fi
2014-01-17 11:54:54 +08:00
The first command ensures that new history items are appended to .bash_history
(instead of overwriting). The second command ensures synchronization of the
history between memory and file system. The third command binds hh to
Ctrl-r shortcut.
.SH AUTHOR
Written by Martin Dvorak <martin.dvorak@mindforger.com>
.SH BUGS
Report bugs to https://github.com/dvorka/hstr/issues
.SH "SEE ALSO"
.BR history (1),
.BR bash (1)