Skip to content

Commit

Permalink
update to latest man and bump version
Browse files Browse the repository at this point in the history 
Signed-off-by: Tin Lai <[email protected]>
  • Loading branch information
@soraxas
soraxas committed Jan 23, 2021
1 parent 8573a6b commit c0ff4d8
Show file tree
Hide file tree
Showing 16 changed files with 96 additions and 64 deletions.
2 changes: 1 addition & 1 deletion libexec/shsh
View file
Original file line number Diff line number Diff line change
Expand Up @@ -124,7 +124,7 @@ for arg; do
;;
--version)
cat << EOF
shsh (shell script handler) v2.4.2
shsh (shell script handler) v2.4.3
Copyright (c) 2014 Juan Ibiapina, 2020 Tin Lai (@soraxas)
This is free software; see the source for copying conditions. There is NO
Expand Down
6 changes: 3 additions & 3 deletions man/man1/shsh-cleanup.1
View file
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.47.15.
.TH SHSH "1" "July 2020" "shell script handler v2.4.2" "User Commands"
.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.47.16.
.TH SHSH "1" "January 2021" "shell script handler v2.4.3" "User Commands"
.SH NAME
shsh \- manual page for shsh v2.4.2
shsh \- manual page for shsh v2.4.3
.SH SYNOPSIS
.B shsh
\fI\,cleanup \/\fR[\fI\,-d|--dry\/\fR]
Expand Down
6 changes: 3 additions & 3 deletions man/man1/shsh-commands.1
View file
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.47.15.
.TH SHSH "1" "July 2020" "shell script handler v2.4.2" "User Commands"
.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.47.16.
.TH SHSH "1" "January 2021" "shell script handler v2.4.3" "User Commands"
.SH NAME
shsh \- manual page for shsh v2.4.2
shsh \- manual page for shsh v2.4.3
.SH SYNOPSIS
.B shsh
\fI\,commands\/\fR
Expand Down
6 changes: 3 additions & 3 deletions man/man1/shsh-completions.1
View file
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.47.15.
.TH SHSH "1" "July 2020" "shell script handler v2.4.2" "User Commands"
.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.47.16.
.TH SHSH "1" "January 2021" "shell script handler v2.4.3" "User Commands"
.SH NAME
shsh \- manual page for shsh v2.4.2
shsh \- manual page for shsh v2.4.3
.SH SYNOPSIS
.B shsh
\fI\,completions <command>\/\fR
Expand Down
6 changes: 3 additions & 3 deletions man/man1/shsh-help.1
View file
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.47.15.
.TH SHSH "1" "July 2020" "shell script handler v2.4.2" "User Commands"
.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.47.16.
.TH SHSH "1" "January 2021" "shell script handler v2.4.3" "User Commands"
.SH NAME
shsh \- manual page for shsh v2.4.2
shsh \- manual page for shsh v2.4.3
.SH SYNOPSIS
.B shsh
\fI\,help \/\fR[\fI\,--usage\/\fR] \fI\,COMMAND\/\fR
Expand Down
6 changes: 3 additions & 3 deletions man/man1/shsh-init.1
View file
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.47.15.
.TH SHSH "1" "July 2020" "shell script handler v2.4.2" "User Commands"
.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.47.16.
.TH SHSH "1" "January 2021" "shell script handler v2.4.3" "User Commands"
.SH NAME
shsh \- manual page for shsh v2.4.2
shsh \- manual page for shsh v2.4.3
.SH SYNOPSIS
.B eval
\fI\,"$(shsh init SHELL)"\/\fR
Expand Down
30 changes: 19 additions & 11 deletions man/man1/shsh-install.1
View file
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.47.15.
.TH SHSH "1" "July 2020" "shell script handler v2.4.2" "User Commands"
.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.47.16.
.TH SHSH "1" "January 2021" "shell script handler v2.4.3" "User Commands"
.SH NAME
shsh \- manual page for shsh v2.4.2
shsh \- manual page for shsh v2.4.3
.SH SYNOPSIS
.B shsh
\fI\,install \/\fR[\fI\,site\/\fR]\fI\,/<package>\/\fR[\fI\,@ref\/\fR] [\fI\,<folder>/<folder>\/\fR]
Expand Down Expand Up @@ -64,36 +64,44 @@ multiples are given, they will be run in sequential order.
a+x
Before linking, add executable bit to all files.
.SH EXAMPLES
.TP
.IP
shsh install soraxas/dot\-reminder
.IP
install 'soraxas/dot\-reminder' as a package
.TP
.IP
shsh install soraxas/git\-utils git/tools
.IP
install 'soraxas/git\-utils' to a folder within 'git/tools'
.TP
.IP
shsh install \-\-ssh <package>
.IP
install with ssh protocal (rather than https)
.TP
.IP
shsh install <package> \-v FISH_COMPLETIONS=synoservice.fish:forgit.fish
.IP
link 'synoservice.fish' and 'forgit.fish' as fish
completion files
.TP
.IP
shsh install <package> \-\-hook pre="mv bin/foo bin/bar"
.IP
Execute the script "mv bin/foo bin/bar" before `shsh`
performs linking (e.g. this script renames the binary)
.TP
.IP
shsh install <package> \-\-hook +x=foobar
.IP
add a hook that add executable bits to the file 'foobar',
before linking is performed
.TP
.IP
shsh install <package> \-h pre='make all' \-h post='rm \-r build/*'
.IP
add a hook that runs 'make all' to build binaries, right
after cloning and before linking is performed. Then,
linking is performed with its usual rules (i.e. all
executable files in root and in bin/). Finally,
\&'rm \-r build/*' is ran to remove leftovers.
.TP
.IP
shsh install \-\-plain wsl\-tools/win32yank \-h pre='curl \-sLo out.zip \e
.IP
https://<..>/releases/<..>.zip && unzip out.zip' \-h +x=win32yank.exe
.IP
add a plain package by using curl to download pre\-built
Expand Down
6 changes: 3 additions & 3 deletions man/man1/shsh-link.1
View file
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.47.15.
.TH SHSH "1" "July 2020" "shell script handler v2.4.2" "User Commands"
.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.47.16.
.TH SHSH "1" "January 2021" "shell script handler v2.4.3" "User Commands"
.SH NAME
shsh \- manual page for shsh v2.4.2
shsh \- manual page for shsh v2.4.3
.SH SYNOPSIS
.B shsh
\fI\,link \/\fR[\fI\,--no-deps\/\fR] \fI\,<directory> <package>\/\fR
Expand Down
6 changes: 3 additions & 3 deletions man/man1/shsh-list.1
View file
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.47.15.
.TH SHSH "1" "July 2020" "shell script handler v2.4.2" "User Commands"
.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.47.16.
.TH SHSH "1" "January 2021" "shell script handler v2.4.3" "User Commands"
.SH NAME
shsh \- manual page for shsh v2.4.2
shsh \- manual page for shsh v2.4.3
.SH SYNOPSIS
.B shsh
\fI\,list \/\fR[\fI\,-d|--details\/\fR]
Expand Down
6 changes: 3 additions & 3 deletions man/man1/shsh-outdated.1
View file
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.47.15.
.TH SHSH "1" "July 2020" "shell script handler v2.4.2" "User Commands"
.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.47.16.
.TH SHSH "1" "January 2021" "shell script handler v2.4.3" "User Commands"
.SH NAME
shsh \- manual page for shsh v2.4.2
shsh \- manual page for shsh v2.4.3
.SH SYNOPSIS
.B shsh
\fI\,outdated \/\fR[\fI\,-q|--quiet\/\fR]
Expand Down
6 changes: 3 additions & 3 deletions man/man1/shsh-package-path.1
View file
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.47.15.
.TH SHSH "1" "July 2020" "shell script handler v2.4.2" "User Commands"
.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.47.16.
.TH SHSH "1" "January 2021" "shell script handler v2.4.3" "User Commands"
.SH NAME
shsh \- manual page for shsh v2.4.2
shsh \- manual page for shsh v2.4.3
.SH SYNOPSIS
.B source
\fI\,"$(shsh package-path <package>)/file.sh"\/\fR
Expand Down
6 changes: 3 additions & 3 deletions man/man1/shsh-refresh.1
View file
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.47.15.
.TH SHSH "1" "July 2020" "shell script handler v2.4.2" "User Commands"
.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.47.16.
.TH SHSH "1" "January 2021" "shell script handler v2.4.3" "User Commands"
.SH NAME
shsh \- manual page for shsh v2.4.2
shsh \- manual page for shsh v2.4.3
.SH SYNOPSIS
.B shsh
\fI\,refresh <package> \/\fR[\fI\,--verbose\/\fR] [\fI\,-a|--all\/\fR]
Expand Down
6 changes: 3 additions & 3 deletions man/man1/shsh-self-upgrade.1
View file
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.47.15.
.TH SHSH "1" "July 2020" "shell script handler v2.4.2" "User Commands"
.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.47.16.
.TH SHSH "1" "January 2021" "shell script handler v2.4.3" "User Commands"
.SH NAME
shsh \- manual page for shsh v2.4.2
shsh \- manual page for shsh v2.4.3
.SH SYNOPSIS
.B shsh
\fI\,self-upgrade\/\fR
Expand Down
6 changes: 3 additions & 3 deletions man/man1/shsh-uninstall.1
View file
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.47.15.
.TH SHSH "1" "July 2020" "shell script handler v2.4.2" "User Commands"
.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.47.16.
.TH SHSH "1" "January 2021" "shell script handler v2.4.3" "User Commands"
.SH NAME
shsh \- manual page for shsh v2.4.2
shsh \- manual page for shsh v2.4.3
.SH SYNOPSIS
.B shsh
\fI\,uninstall <package>\/\fR
Expand Down
16 changes: 12 additions & 4 deletions man/man1/shsh-upgrade.1
View file
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.47.15.
.TH SHSH "1" "July 2020" "shell script handler v2.4.2" "User Commands"
.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.47.16.
.TH SHSH "1" "January 2021" "shell script handler v2.4.3" "User Commands"
.SH NAME
shsh \- manual page for shsh v2.4.2
shsh \- manual page for shsh v2.4.3
.SH SYNOPSIS
.B shsh
\fI\,upgrade <package>\/\fR
\fI\,upgrade <package> \/\fR[\fI\,-f|--force\/\fR]
.br
.B shsh
\fI\,upgrade <-a|--all>\/\fR
Expand All @@ -14,6 +14,14 @@ Upgrades a package
.TP
\fB\-a\fR, \fB\-\-all\fR
upgrade all packages, instead of invidivual package
.TP
\fB\-f\fR, \fB\-\-force\fR
force upgrade a package even if the cloned repository is
up\-to\-date
.TP
\fB\-\-nohooks\fR
supress the evaluation of existing hooks in SHSHRC file
(default is executing all previously saved hooks)
.SH AUTHOR
Written by Tin Lai (@soraxas)
.SH COPYRIGHT
Expand Down
40 changes: 28 additions & 12 deletions man/man1/shsh.1
View file
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.47.15.
.TH SHSH "1" "July 2020" "shell script handler v2.4.2" "User Commands"
.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.47.16.
.TH SHSH "1" "January 2021" "shell script handler v2.4.3" "User Commands"
.SH NAME
shsh \- manual page for shsh v2.4.2
shsh \- manual page for shsh v2.4.3
.SH SYNOPSIS
.B shsh
\fI\,<command> \/\fR[\fI\,<command args>\/\fR] [\fI\,--verbose\/\fR] [\fI\,--help\/\fR]
Expand Down Expand Up @@ -174,36 +174,44 @@ multiples are given, they will be run in sequential order.
a+x
Before linking, add executable bit to all files.
.SS EXAMPLES
.TP
.IP
shsh install soraxas/dot\-reminder
.IP
install 'soraxas/dot\-reminder' as a package
.TP
.IP
shsh install soraxas/git\-utils git/tools
.IP
install 'soraxas/git\-utils' to a folder within 'git/tools'
.TP
.IP
shsh install \-\-ssh <package>
.IP
install with ssh protocal (rather than https)
.TP
.IP
shsh install <package> \-v FISH_COMPLETIONS=synoservice.fish:forgit.fish
.IP
link 'synoservice.fish' and 'forgit.fish' as fish
completion files
.TP
.IP
shsh install <package> \-\-hook pre="mv bin/foo bin/bar"
.IP
Execute the script "mv bin/foo bin/bar" before `shsh`
performs linking (e.g. this script renames the binary)
.TP
.IP
shsh install <package> \-\-hook +x=foobar
.IP
add a hook that add executable bits to the file 'foobar',
before linking is performed
.TP
.IP
shsh install <package> \-h pre='make all' \-h post='rm \-r build/*'
.IP
add a hook that runs 'make all' to build binaries, right
after cloning and before linking is performed. Then,
linking is performed with its usual rules (i.e. all
executable files in root and in bin/). Finally,
\&'rm \-r build/*' is ran to remove leftovers.
.TP
.IP
shsh install \-\-plain wsl\-tools/win32yank \-h pre='curl \-sLo out.zip \e
.IP
https://<..>/releases/<..>.zip && unzip out.zip' \-h +x=win32yank.exe
.IP
add a plain package by using curl to download pre\-built
Expand Down Expand Up @@ -269,7 +277,7 @@ uninstall all packages that is not present in SHSHRC file
do not prompt to confirm uninstalling each package
.SH "SUBCMD: SHSH UPGRADE"
.B shsh
\fI\,upgrade <package>\/\fR
\fI\,upgrade <package> \/\fR[\fI\,-f|--force\/\fR]
.br
.B shsh
\fI\,upgrade <-a|--all>\/\fR
Expand All @@ -279,6 +287,14 @@ Upgrades a package
.TP
\fB\-a\fR, \fB\-\-all\fR
upgrade all packages, instead of invidivual package
.TP
\fB\-f\fR, \fB\-\-force\fR
force upgrade a package even if the cloned repository is
up\-to\-date
.TP
\fB\-\-nohooks\fR
supress the evaluation of existing hooks in SHSHRC file
(default is executing all previously saved hooks)
.SH ENVIRONMENT
The following environment variables has effects in `shsh` of
changing the default directories of stored files.
Expand Down

0 comments on commit c0ff4d8

Please sign in to comment.