From 59a6c5e7a88a964dba39c69d28455954e5aaecbd Mon Sep 17 00:00:00 2001 From: Martin Dvorak Date: Wed, 22 Aug 2018 08:21:13 +0200 Subject: [PATCH] hh2hstr automake and man --- build/tarball/tarball-automake.sh | 4 +- configure.ac | 4 +- man/Makefile.am | 2 +- man/hh.1 | 221 ------------------------------ man/hstr.1 | 220 ++++++++++++++++++++++++++++- src/hstr.c | 4 +- 6 files changed, 226 insertions(+), 229 deletions(-) delete mode 100644 man/hh.1 mode change 120000 => 100644 man/hstr.1 diff --git a/build/tarball/tarball-automake.sh b/build/tarball/tarball-automake.sh index 59a273a..3f6523c 100755 --- a/build/tarball/tarball-automake.sh +++ b/build/tarball/tarball-automake.sh @@ -32,7 +32,7 @@ function tarballClean() { rm -rvf atom5te.cache src/.deps rm -vf Makefile Makefile.in aclocal.m4 config.log config.status configure depcomp install-sh missing rm -vf man/Makefile man/Makefile.in - rm -vf src/Makefile src/Makefile.in src/hh src/*.o + rm -vf src/Makefile src/Makefile.in src/hstr src/hh src/*.o } function tarballBuildUsingAutomake() { @@ -59,7 +59,7 @@ function tarballBuildUsingAutomake() { # detect Windows WSL export VENDOR_FILE=/proc/version - export HINT_FILE=/tmp/hh-ms-wsl + export HINT_FILE=/tmp/hstr-ms-wsl if [ -e "${VENDOR_FILE}" ] then diff --git a/configure.ac b/configure.ac index 6265381..32b07de 100644 --- a/configure.ac +++ b/configure.ac @@ -20,7 +20,7 @@ AC_PREREQ([2.69]) -AC_INIT(hh, 1.28.0, martin.dvorak@mindforger.com) +AC_INIT(hstr, 2.0.0, martin.dvorak@mindforger.com) AC_CONFIG_FILES([Makefile src/Makefile man/Makefile]) # Check src dir existence. @@ -110,7 +110,7 @@ AC_FUNC_MALLOC AC_CHECK_FUNCS([memset strdup strstr]) # Bash@Ubuntu@Windows -AC_CHECK_FILE(/tmp/hh-ms-wsl,AC_DEFINE(__MS_WSL__), []) +AC_CHECK_FILE(/tmp/hstr-ms-wsl,AC_DEFINE(__MS_WSL__), []) # Bash CLI completion AC_ARG_WITH([bash-completion-dir], diff --git a/man/Makefile.am b/man/Makefile.am index b4e5c45..c0bf5e3 100644 --- a/man/Makefile.am +++ b/man/Makefile.am @@ -1 +1 @@ -man_MANS = hh.1 hstr.1 +man_MANS = hstr.1 diff --git a/man/hh.1 b/man/hh.1 deleted file mode 100644 index 62db67e..0000000 --- a/man/hh.1 +++ /dev/null @@ -1,221 +0,0 @@ -.TH HH 1 -.SH NAME -\fBhh\fR \- easily view, navigate, sort and use your command history with shell history suggest box. -.SH SYNOPSIS -.B hh [option] [arg1] [arg2]... -.RS 0 -.B hstr [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. -Favorite and frequently used commands can be bookmarked. In addition -\fBhh\fR allows removal of commands from history - for instance with a typo -or with a sensitive content. -.SH OPTIONS -.TP -\fB-h --help\fR -Show help -.TP -\fB-n --non-interactive\fR -Print filtered history on standard output and exit -.TP -\fB-k --kill-last-command\fR -Delete the last command from history and exit -.TP -\fB-f --favorites\fR -Show favorites view immediately -.TP -\fB-s --show-configuration\fR -Show configuration that can be added to ~/.bashrc -.TP -\fB-b --show-blacklist\fR -Show blacklist of commands to be filtered out before history processing -.TP -\fB-V --version\fR -Show version information -.SH KEYS -.TP -\fBpattern\fR -Type to filter shell history. -.TP -\fBCtrl\-e\fR -Toggle regular expression and substring search. -.TP -\fBCtrl\-t\fR -Toggle case sensitive search. -.TP -\fBCtrl\-/\fR, \fBCtrl\-7\fR -Rotate view of history as provided by Bash, ranked history ordered by the number of occurences/length/timestamp and favorites. -.TP -\fBCtrl\-f\fR -Add currently selected command to favorites. -.TP -\fBCtrl\-l\fR -Toggle search pattern case. -.TP -\fBCtrl\-r\fR, \fBUP\fR arrow, \fBDOWN\fR arrow, \fBCtrl\-n\fR, \fBCtrl\-p\fR, \fBCtrl\-j\fR, \fBCtrl\-k\fR -Navigate in the history list. -.TP -\fBTAB\fR, \fBRIGHT\fR arrow -Choose currently selected item for completion and let user to edit it on the command prompt. -.TP -\fBLEFT\fR arrow -Choose currently selected item for completion and let user to edit it in editor (fix command). -.TP -\fBENTER\fR -Choose currently selected item for completion and execute it. -.TP -\fBDEL\fR -Remove currently selected item from the shell history. -.TP -\fBBACKSPACE\fR, \fBCtrl\-h\fR -Delete last pattern character. -.TP -\fBCtrl\-u\fR, \fBCtrl\-w\fR -Delete pattern and search again. -.TP -\fBCtrl\-x\fR -Write changes to shell history and exit. -.TP -\fBCtrl\-g\fR -Exit with empty prompt. -.SH ENVIRONMENT VARIABLES -\fBhh\fR defines the following environment variables: -.TP -\fBHH_CONFIG\fR -Configuration options: - -\fIhicolor\fR - Get more colors with this option (default is monochromatic). - -\fImonochromatic\fR - Ensure black and white view. - -\fIprompt-bottom\fR - Show prompt at the bottom of the screen (default is prompt at the top). - -\fInoconfirm\fR - Do not ask for confirmation on a history entry delete (default is with confirmation). - -\fIregexp\fR - Filter command history using regular expressions. - -\fIsubstring\fR - Filter command history using substring. - -\fIkeywords\fR - Filter command history using keywords - item matches if contains all keywords in pattern in any order (keywords match is default). - -\fIcasesensitive\fR - Make history filtering case sensitive (it's case insensitive by default). - -\fIrawhistory\fR - Show normal history as a default view (metric-based view is shown otherwise). - -\fIfavorites\fR - Show favorites as a default view (metric-based view is shown otherwise). - -\fIstatic-favs\fR - Do not put recently used favorite to the head of favorites (favorites are reordered by default). - -\fIskip-favs-comments\fR - Skip comments (lines beginning with #) when loading ~/.hh_favorites (all lines are loaded by default). - -\fIduplicates\fR - Show duplicates in rawhistory (duplicates are discarded by default). - -\fIverbose-kill\fR - Print the last command command deleted from history (nothing is printed by default). - -\fIblacklist\fR - Load list of commands to skip when processing history from ~/.hh_blacklist (built-in blacklist used otherwise). - -\fIkeep-page\fR - Don't clear page with command selection on exit (page is cleared by default). - -\fIbig-keys-skip\fR - Skip big history entries i.e. very long lines (default). - -\fIbig-keys-floor\fR - Use different sorting slot for big keys when building metrics-based view (big keys are skipped by default). - -\fIbig-keys-exit\fR - Exit (fail) on presence of a big key in history (big keys are skipped by default). - -\fIwarning\fR - Show warning. - -\fIdebug\fR - Show debug information. - -Example: - \fBexport HH_CONFIG=hicolor,regexp,rawhistory\fR - -.TP -\fBHH_PROMPT\fR -Change prompt string which is \fBuser@host$\fR by default. - -Example: - \fBexport HH_PROMPT="$ "\fR - -.SH FILES -.TP -\fB~/.hh_favorites\fR - Bookmarked favorite commands. -.TP -\fB~/.hh_blacklist\fR - Commands to be hidden. - -.SH BASH CONFIGURATION -Optionally add the following lines to ~/.bashrc: -.nf -.sp -export HH_CONFIG=hicolor # get more colors -shopt -s histappend # append new history items to .bash_history -export HISTCONTROL=ignorespace # leading space hides commands from history -export HISTFILESIZE=10000 # increase history file size (default is 500) -export HISTSIZE=${HISTFILESIZE} # increase history size (default is 500) -export PROMPT_COMMAND="history \-a; history \-n; ${PROMPT_COMMAND}" -# if this is interactive shell, then bind hh to Ctrl-r (for Vi mode check doc) -if [[ $\- =~ .*i.* ]]; then bind '"\eC\-r": "\eC\-a hh -- \eC-j"'; fi -.sp -.fi -The prompt command ensures synchronization of the history between BASH memory -and history file. -.SH ZSH CONFIGURATION -Optionally add the following lines to ~/.zshrc: -.nf -.sp -export HISTFILE=~/.zsh_history # ensure history file visibility -export HH_CONFIG=hicolor # get more colors -bindkey -s "\eC\-r" "\eeqhh\en" # bind hh to Ctrl-r (for Vi mode check doc, experiment with --) -.sp -.fi -.SH EXAMPLES -.TP -\fBhh git\fR - Start `hh` and show only history items containing 'git'. -.TP -\fBhh cpp add git\fR - Start `hh` and show only history items containing 'cpp', 'add' and 'git'. -.TP -\fBhh --non-interactive git\fR - Print history items containing 'git' to standard output and exit. -.TP -\fBhh --show-configuration >> ~/.bashrc\fR - Append default \fBhh\fR configuration to your Bash profile. -.TP -\fBhh --show-blacklist\fR - Show blacklist configured for history processing. -.SH AUTHOR -Written by Martin Dvorak -.SH BUGS -Report bugs to https://github.com/dvorka/hstr/issues -.SH "SEE ALSO" -.BR history (1), -.BR bash (1), -.BR zsh (1) diff --git a/man/hstr.1 b/man/hstr.1 deleted file mode 120000 index 363526e..0000000 --- a/man/hstr.1 +++ /dev/null @@ -1 +0,0 @@ -hh.1 \ No newline at end of file diff --git a/man/hstr.1 b/man/hstr.1 new file mode 100644 index 0000000..6f33de5 --- /dev/null +++ b/man/hstr.1 @@ -0,0 +1,219 @@ +.TH HSTR 1 +.SH NAME +\fBhstr\fR \- easily view, navigate, sort and use your command history with shell history suggest box. +.SH SYNOPSIS +.B hstr [option] [arg1] [arg2]... +.SH DESCRIPTION +.B hstr +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. +Favorite and frequently used commands can be bookmarked. In addition +\fBhstr\fR allows removal of commands from history - for instance with a typo +or with a sensitive content. +.SH OPTIONS +.TP +\fB-h --help\fR +Show help +.TP +\fB-n --non-interactive\fR +Print filtered history on standard output and exit +.TP +\fB-k --kill-last-command\fR +Delete the last command from history and exit +.TP +\fB-f --favorites\fR +Show favorites view immediately +.TP +\fB-s --show-configuration\fR +Show configuration that can be added to ~/.bashrc +.TP +\fB-b --show-blacklist\fR +Show blacklist of commands to be filtered out before history processing +.TP +\fB-V --version\fR +Show version information +.SH KEYS +.TP +\fBpattern\fR +Type to filter shell history. +.TP +\fBCtrl\-e\fR +Toggle regular expression and substring search. +.TP +\fBCtrl\-t\fR +Toggle case sensitive search. +.TP +\fBCtrl\-/\fR, \fBCtrl\-7\fR +Rotate view of history as provided by Bash, ranked history ordered by the number of occurences/length/timestamp and favorites. +.TP +\fBCtrl\-f\fR +Add currently selected command to favorites. +.TP +\fBCtrl\-l\fR +Toggle search pattern case. +.TP +\fBCtrl\-r\fR, \fBUP\fR arrow, \fBDOWN\fR arrow, \fBCtrl\-n\fR, \fBCtrl\-p\fR, \fBCtrl\-j\fR, \fBCtrl\-k\fR +Navigate in the history list. +.TP +\fBTAB\fR, \fBRIGHT\fR arrow +Choose currently selected item for completion and let user to edit it on the command prompt. +.TP +\fBLEFT\fR arrow +Choose currently selected item for completion and let user to edit it in editor (fix command). +.TP +\fBENTER\fR +Choose currently selected item for completion and execute it. +.TP +\fBDEL\fR +Remove currently selected item from the shell history. +.TP +\fBBACKSPACE\fR, \fBCtrl\-h\fR +Delete last pattern character. +.TP +\fBCtrl\-u\fR, \fBCtrl\-w\fR +Delete pattern and search again. +.TP +\fBCtrl\-x\fR +Write changes to shell history and exit. +.TP +\fBCtrl\-g\fR +Exit with empty prompt. +.SH ENVIRONMENT VARIABLES +\fBhstr\fR defines the following environment variables: +.TP +\fBHSTR_CONFIG\fR +Configuration options: + +\fIhicolor\fR + Get more colors with this option (default is monochromatic). + +\fImonochromatic\fR + Ensure black and white view. + +\fIprompt-bottom\fR + Show prompt at the bottom of the screen (default is prompt at the top). + +\fInoconfirm\fR + Do not ask for confirmation on a history entry delete (default is with confirmation). + +\fIregexp\fR + Filter command history using regular expressions. + +\fIsubstring\fR + Filter command history using substring. + +\fIkeywords\fR + Filter command history using keywords - item matches if contains all keywords in pattern in any order (keywords match is default). + +\fIcasesensitive\fR + Make history filtering case sensitive (it's case insensitive by default). + +\fIrawhistory\fR + Show normal history as a default view (metric-based view is shown otherwise). + +\fIfavorites\fR + Show favorites as a default view (metric-based view is shown otherwise). + +\fIstatic-favs\fR + Do not put recently used favorite to the head of favorites (favorites are reordered by default). + +\fIskip-favs-comments\fR + Skip comments (lines beginning with #) when loading ~/.hstr_favorites (all lines are loaded by default). + +\fIduplicates\fR + Show duplicates in rawhistory (duplicates are discarded by default). + +\fIverbose-kill\fR + Print the last command command deleted from history (nothing is printed by default). + +\fIblacklist\fR + Load list of commands to skip when processing history from ~/.hstr_blacklist (built-in blacklist used otherwise). + +\fIkeep-page\fR + Don't clear page with command selection on exit (page is cleared by default). + +\fIbig-keys-skip\fR + Skip big history entries i.e. very long lines (default). + +\fIbig-keys-floor\fR + Use different sorting slot for big keys when building metrics-based view (big keys are skipped by default). + +\fIbig-keys-exit\fR + Exit (fail) on presence of a big key in history (big keys are skipped by default). + +\fIwarning\fR + Show warning. + +\fIdebug\fR + Show debug information. + +Example: + \fBexport HSTR_CONFIG=hicolor,regexp,rawhistory\fR + +.TP +\fBHSTR_PROMPT\fR +Change prompt string which is \fBuser@host$\fR by default. + +Example: + \fBexport HSTR_PROMPT="$ "\fR + +.SH FILES +.TP +\fB~/.hstr_favorites\fR + Bookmarked favorite commands. +.TP +\fB~/.hstr_blacklist\fR + Commands to be hidden. + +.SH BASH CONFIGURATION +Optionally add the following lines to ~/.bashrc: +.nf +.sp +alias hh=hstr # hh to be shorter alias hstr +export HSTR_CONFIG=hicolor # get more colors +shopt -s histappend # append new history items to .bash_history +export HISTCONTROL=ignorespace # leading space hides commands from history +export HISTFILESIZE=10000 # increase history file size (default is 500) +export HISTSIZE=${HISTFILESIZE} # increase history size (default is 500) +# ensure synchronization between Bash memory and history file +export PROMPT_COMMAND="history \-a; history \-n; ${PROMPT_COMMAND}" +# if this is interactive shell, then bind hstr to Ctrl-r (for Vi mode check doc) +if [[ $\- =~ .*i.* ]]; then bind '"\eC\-r": "\eC\-a hstr -- \eC-j"'; fi +.sp +.fi +.SH ZSH CONFIGURATION +Optionally add the following lines to ~/.zshrc: +.nf +.sp +export HISTFILE=~/.zsh_history # ensure history file visibility +export HSTR_CONFIG=hicolor # get more colors +bindkey -s "\eC\-r" "\eeqhstr\en" # bind hstr to Ctrl-r (for Vi mode check doc, experiment with --) +.sp +.fi +.SH EXAMPLES +.TP +\fBhstr git\fR + Start \fBhstr\fR and show only history items containing 'git'. +.TP +\fBhstr cpp add git\fR + Start \fBhstr\fR and show only history items containing 'cpp', 'add' and 'git'. +.TP +\fBhstr --non-interactive git\fR + Print history items containing 'git' to standard output and exit. +.TP +\fBhstr --show-configuration >> ~/.bashrc\fR + Append default \fBhstr\fR configuration to your Bash profile. +.TP +\fBhstr --show-blacklist\fR + Show blacklist configured for history processing. +.SH AUTHOR +Written by Martin Dvorak +.SH BUGS +Report bugs to https://github.com/dvorka/hstr/issues +.SH "SEE ALSO" +.BR history (1), +.BR bash (1), +.BR zsh (1) diff --git a/src/hstr.c b/src/hstr.c index 04aa3e3..4626d83 100644 --- a/src/hstr.c +++ b/src/hstr.c @@ -65,8 +65,8 @@ #define HH_COLOR_DELETE 4 #define HH_COLOR_MATCH 5 -#define HH_ENV_VAR_CONFIG "HH_CONFIG" -#define HH_ENV_VAR_PROMPT "HH_PROMPT" +#define HH_ENV_VAR_CONFIG "HSTR_CONFIG" +#define HH_ENV_VAR_PROMPT "HSTR_PROMPT" #define HH_CONFIG_THEME_MONOCHROMATIC "monochromatic" #define HH_CONFIG_THEME_HICOLOR "hicolor"