Skip to content

Commit

Permalink
update mans
Browse files Browse the repository at this point in the history 
Signed-off-by: Tin Lai <[email protected]>
  • Loading branch information
@soraxas
soraxas committed Nov 28, 2023
1 parent e463439 commit bc483ed
Show file tree
Hide file tree
Showing 19 changed files with 67 additions and 69 deletions.
2 changes: 1 addition & 1 deletion libexec/shsh
View file
Original file line number Diff line number Diff line change
Expand Up @@ -120,7 +120,7 @@ for arg; do
;;
--version)
cat << EOF
shsh (shell script handler) v3.0.2
shsh (shell script handler) v3.1.0
Copyright (c) 2014 Juan Ibiapina, 2020 Tin Lai (@soraxas)
This is free software; see the source for copying conditions. There is NO
Expand Down
4 changes: 2 additions & 2 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.49.3.
.TH SHSH "1" "September 2023" "shell script handler v3.0.2" "User Commands"
.TH SHSH "1" "November 2023" "shell script handler v3.1.0" "User Commands"
.SH NAME
shsh \- manual page for shsh v3.0.2
shsh \- manual page for shsh v3.1.0
.SH SYNOPSIS
.B shsh
\fI\,cleanup \/\fR[\fI\,-d|--dry\/\fR]
Expand Down
4 changes: 2 additions & 2 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.49.3.
.TH SHSH "1" "September 2023" "shell script handler v3.0.2" "User Commands"
.TH SHSH "1" "November 2023" "shell script handler v3.1.0" "User Commands"
.SH NAME
shsh \- manual page for shsh v3.0.2
shsh \- manual page for shsh v3.1.0
.SH SYNOPSIS
.B shsh
\fI\,commands\/\fR
Expand Down
4 changes: 2 additions & 2 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.49.3.
.TH SHSH "1" "September 2023" "shell script handler v3.0.2" "User Commands"
.TH SHSH "1" "November 2023" "shell script handler v3.1.0" "User Commands"
.SH NAME
shsh \- manual page for shsh v3.0.2
shsh \- manual page for shsh v3.1.0
.SH SYNOPSIS
.B shsh
\fI\,completions <command>\/\fR
Expand Down
4 changes: 2 additions & 2 deletions man/man1/shsh-edit.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.49.3.
.TH SHSH "1" "September 2023" "shell script handler v3.0.2" "User Commands"
.TH SHSH "1" "November 2023" "shell script handler v3.1.0" "User Commands"
.SH NAME
shsh \- manual page for shsh v3.0.2
shsh \- manual page for shsh v3.1.0
.SH SYNOPSIS
.B shsh
\fI\,edit\/\fR
Expand Down
4 changes: 2 additions & 2 deletions man/man1/shsh-get.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.49.3.
.TH SHSH "1" "September 2023" "shell script handler v3.0.2" "User Commands"
.TH SHSH "1" "November 2023" "shell script handler v3.1.0" "User Commands"
.SH NAME
shsh \- manual page for shsh v3.0.2
shsh \- manual page for shsh v3.1.0
.SH SYNOPSIS
.B shsh
\fI\,get <package>\/\fR
Expand Down
4 changes: 2 additions & 2 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.49.3.
.TH SHSH "1" "September 2023" "shell script handler v3.0.2" "User Commands"
.TH SHSH "1" "November 2023" "shell script handler v3.1.0" "User Commands"
.SH NAME
shsh \- manual page for shsh v3.0.2
shsh \- manual page for shsh v3.1.0
.SH SYNOPSIS
.B shsh
\fI\,help \/\fR[\fI\,--usage\/\fR] \fI\,COMMAND\/\fR
Expand Down
4 changes: 2 additions & 2 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.49.3.
.TH SHSH "1" "September 2023" "shell script handler v3.0.2" "User Commands"
.TH SHSH "1" "November 2023" "shell script handler v3.1.0" "User Commands"
.SH NAME
shsh \- manual page for shsh v3.0.2
shsh \- manual page for shsh v3.1.0
.SH SYNOPSIS
.B eval
\fI\,"$(shsh init SHELL)"\/\fR
Expand Down
32 changes: 14 additions & 18 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.49.3.
.TH SHSH "1" "September 2023" "shell script handler v3.0.2" "User Commands"
.TH SHSH "1" "November 2023" "shell script handler v3.1.0" "User Commands"
.SH NAME
shsh \- manual page for shsh v3.0.2
shsh \- manual page for shsh v3.1.0
.SH SYNOPSIS
.B shsh
\fI\,install \/\fR[\fI\,site\/\fR]\fI\,/<package>\/\fR[\fI\,@ref\/\fR] [\fI\,<folder>/<folder>\/\fR]
Expand All @@ -23,6 +23,10 @@ shsh install \fB\-\-plain\fR <folder>/<folder>
add HOOK to this package, which is triggered while
installing or upgrading a package
.HP
\fB\-r\fR, \fB\-\-recipe\fR interpret the given package name as a hosted recipt at
.IP
github.com/soraxas/shsh\-recipes.
.HP
\fB\-v\fR \fB\-\-variable\fR <VAR>=<VAL>
.IP
set a variable VAR with value VAL,
Expand Down Expand Up @@ -71,44 +75,36 @@ multiples are given, they will be run in sequential order.
a+x
Before linking, add executable bit to all files.
.SH EXAMPLES
.IP
.TP
shsh install soraxas/dot\-reminder
.IP
install 'soraxas/dot\-reminder' as a package
.IP
.TP
shsh install soraxas/git\-utils git/tools
.IP
install 'soraxas/git\-utils' to a folder within 'git/tools'
.IP
.TP
shsh install \-\-ssh <package>
.IP
install with ssh protocal (rather than https)
.IP
.TP
shsh install <package> \-v FISH_COMPLETIONS=synoservice.fish:forgit.fish
.IP
link 'synoservice.fish' and 'forgit.fish' as fish
completion files
.IP
.TP
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)
.IP
.TP
shsh install <package> \-\-hook +x=foobar
.IP
add a hook that add executable bits to the file 'foobar',
before linking is performed
.IP
.TP
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.
.IP
.TP
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
4 changes: 2 additions & 2 deletions man/man1/shsh-junest.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.49.3.
.TH SHSH "1" "September 2023" "shell script handler v3.0.2" "User Commands"
.TH SHSH "1" "November 2023" "shell script handler v3.1.0" "User Commands"
.SH NAME
shsh \- manual page for shsh v3.0.2
shsh \- manual page for shsh v3.1.0
.SH SYNOPSIS
.B shsh
\fI\,junest \/\fR[\fI\,-h|--help\/\fR] \fI\,<sub_command>\/\fR
Expand Down
4 changes: 2 additions & 2 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.49.3.
.TH SHSH "1" "September 2023" "shell script handler v3.0.2" "User Commands"
.TH SHSH "1" "November 2023" "shell script handler v3.1.0" "User Commands"
.SH NAME
shsh \- manual page for shsh v3.0.2
shsh \- manual page for shsh v3.1.0
.SH SYNOPSIS
.B shsh
\fI\,link \/\fR[\fI\,--no-deps\/\fR] \fI\,<directory> <package> \/\fR[\fI\,-h|--hook <hook>\/\fR] [\fI\,-v|--variable <VAR>=<VAL>\/\fR]
Expand Down
4 changes: 2 additions & 2 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.49.3.
.TH SHSH "1" "September 2023" "shell script handler v3.0.2" "User Commands"
.TH SHSH "1" "November 2023" "shell script handler v3.1.0" "User Commands"
.SH NAME
shsh \- manual page for shsh v3.0.2
shsh \- manual page for shsh v3.1.0
.SH SYNOPSIS
.B shsh
\fI\,list \/\fR[\fI\,-d|--details\/\fR]
Expand Down
4 changes: 2 additions & 2 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.49.3.
.TH SHSH "1" "September 2023" "shell script handler v3.0.2" "User Commands"
.TH SHSH "1" "November 2023" "shell script handler v3.1.0" "User Commands"
.SH NAME
shsh \- manual page for shsh v3.0.2
shsh \- manual page for shsh v3.1.0
.SH SYNOPSIS
.B shsh
\fI\,outdated \/\fR[\fI\,-q|--quiet\/\fR]
Expand Down
4 changes: 2 additions & 2 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.49.3.
.TH SHSH "1" "September 2023" "shell script handler v3.0.2" "User Commands"
.TH SHSH "1" "November 2023" "shell script handler v3.1.0" "User Commands"
.SH NAME
shsh \- manual page for shsh v3.0.2
shsh \- manual page for shsh v3.1.0
.SH SYNOPSIS
.B source
\fI\,"$(shsh package-path <package>)/file.sh"\/\fR
Expand Down
4 changes: 2 additions & 2 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.49.3.
.TH SHSH "1" "September 2023" "shell script handler v3.0.2" "User Commands"
.TH SHSH "1" "November 2023" "shell script handler v3.1.0" "User Commands"
.SH NAME
shsh \- manual page for shsh v3.0.2
shsh \- manual page for shsh v3.1.0
.SH SYNOPSIS
.B shsh
\fI\,refresh <package> \/\fR[\fI\,--verbose\/\fR] [\fI\,-a|--all\/\fR]
Expand Down
4 changes: 2 additions & 2 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.49.3.
.TH SHSH "1" "September 2023" "shell script handler v3.0.2" "User Commands"
.TH SHSH "1" "November 2023" "shell script handler v3.1.0" "User Commands"
.SH NAME
shsh \- manual page for shsh v3.0.2
shsh \- manual page for shsh v3.1.0
.SH SYNOPSIS
.B shsh
\fI\,self-upgrade\/\fR
Expand Down
4 changes: 2 additions & 2 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.49.3.
.TH SHSH "1" "September 2023" "shell script handler v3.0.2" "User Commands"
.TH SHSH "1" "November 2023" "shell script handler v3.1.0" "User Commands"
.SH NAME
shsh \- manual page for shsh v3.0.2
shsh \- manual page for shsh v3.1.0
.SH SYNOPSIS
.B shsh
\fI\,uninstall <package>\/\fR
Expand Down
4 changes: 2 additions & 2 deletions man/man1/shsh-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.49.3.
.TH SHSH "1" "September 2023" "shell script handler v3.0.2" "User Commands"
.TH SHSH "1" "November 2023" "shell script handler v3.1.0" "User Commands"
.SH NAME
shsh \- manual page for shsh v3.0.2
shsh \- manual page for shsh v3.1.0
.SH SYNOPSIS
.B shsh
\fI\,upgrade <package> \/\fR[\fI\,-f|--force\/\fR]
Expand Down
38 changes: 20 additions & 18 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.49.3.
.TH SHSH "1" "September 2023" "shell script handler v3.0.2" "User Commands"
.TH SHSH "1" "November 2023" "shell script handler v3.1.0" "User Commands"
.SH NAME
shsh \- manual page for shsh v3.0.2
shsh \- manual page for shsh v3.1.0
.SH SYNOPSIS
.B shsh
\fI\,<command> \/\fR[\fI\,<command args>\/\fR] [\fI\,--verbose\/\fR] [\fI\,--help\/\fR]
Expand Down Expand Up @@ -156,6 +156,10 @@ shsh install \fB\-\-plain\fR <folder>/<folder>
add HOOK to this package, which is triggered while
installing or upgrading a package
.HP
\fB\-r\fR, \fB\-\-recipe\fR interpret the given package name as a hosted recipt at
.IP
github.com/soraxas/shsh\-recipes.
.HP
\fB\-v\fR \fB\-\-variable\fR <VAR>=<VAL>
.IP
set a variable VAR with value VAL,
Expand Down Expand Up @@ -204,44 +208,36 @@ multiples are given, they will be run in sequential order.
a+x
Before linking, add executable bit to all files.
.SS EXAMPLES
.IP
.TP
shsh install soraxas/dot\-reminder
.IP
install 'soraxas/dot\-reminder' as a package
.IP
.TP
shsh install soraxas/git\-utils git/tools
.IP
install 'soraxas/git\-utils' to a folder within 'git/tools'
.IP
.TP
shsh install \-\-ssh <package>
.IP
install with ssh protocal (rather than https)
.IP
.TP
shsh install <package> \-v FISH_COMPLETIONS=synoservice.fish:forgit.fish
.IP
link 'synoservice.fish' and 'forgit.fish' as fish
completion files
.IP
.TP
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)
.IP
.TP
shsh install <package> \-\-hook +x=foobar
.IP
add a hook that add executable bits to the file 'foobar',
before linking is performed
.IP
.TP
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.
.IP
.TP
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 @@ -383,6 +379,12 @@ list of man pages to link
[default: all files in man/*.[0\-9] and
man/man.[0\-9]/*.[0\-9]]
.TP
MANS_ROOT
directory to search for mans. This has higher
priority than MANS.
[default: all files in man/*.[0\-9] and
man/man.[0\-9]/*.[0\-9]]
.TP
BASH_COMPLETIONS
list of bash shell completion files to link
.TP
Expand Down

0 comments on commit bc483ed

Please sign in to comment.