Skip to content

Commit

Permalink
Bump version number
Browse files Browse the repository at this point in the history
  • Loading branch information
marcransome committed Dec 30, 2024
1 parent 1e3dfa7 commit e54b0ae
Show file tree
Hide file tree
Showing 5 changed files with 256 additions and 118 deletions.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -150,7 +150,7 @@ Use the `status` command without arguments to view the global status of all pond

```console
$ pond status
● pond 2.6.0
● pond 2.6.1
Health: good
Ponds: 1 (1 enabled; 1 loaded)
Loaded: /root/.config/fish/pond
Expand Down
74 changes: 27 additions & 47 deletions docs/pond.1
Original file line number Diff line number Diff line change
@@ -1,9 +1,7 @@
.\" Automatically generated by Pandoc 2.14.0.3
.\" Automatically generated by Pandoc 3.1.12.3
.\"
.TH "pond" "1" "" "Version 2.6.0" "Pond User\[cq]s Guide"
.hy
.TH "pond" "1" "" "Version 2.6.1" "Pond User\[cq]s Guide"
.SH NAME
.PP
\f[B]pond\f[R] \[em] a shell environment manager for the fish shell
.SH SYNOPSIS
.PP
Expand All @@ -13,18 +11,17 @@
.PD
\f[B]pond\f[R] \f[I]command\f[R] [\f[I]options\f[R]] \&...
.SH DESCRIPTION
.PP
A \f[I]pond\f[R] represents a named collection of functions in the fish
shell.
.PP
Each pond comprises a directory containing one or more user-defined
Each pond comprises a directory containing one or more user\-defined
functions.
Functions belonging to a pond may be \f[I]autoloaded\f[R] by name if a
pond was enabled (see \f[B]enable\f[R]) prior to the shell being created
or if the pond was loaded using the \f[B]load\f[R] command in the
current shell.
.PP
In addition to user-defined functions, two special functions (see
In addition to user\-defined functions, two special functions (see
\f[B]autoload\f[R] and \f[B]autounload\f[R]) are automatically executed
if they exist.
These functions are the recommended way of setting or unsetting
Expand All @@ -34,68 +31,64 @@ Arguments can be read from standard input when \f[B]pond\f[R] is used in
a pipeline.
For example, to remove all disabled ponds:
.PP
\f[I]Example:\f[R] \f[B]pond list --disabled | pond remove\f[R]
\f[I]Example:\f[R] \f[B]pond list \-\-disabled | pond remove\f[R]
.PP
All arguments passed via standard input are appended to the arguments
already present in the \f[B]pond\f[R] command.
When used in this way, the \f[B]--yes\f[R] option is assumed by commands
that support it, meaning user confirmation prompts will be automatically
accepted for those operations (see \f[B]COMMANDS\f[R] to determine which
commands this applies to).
When used in this way, the \f[B]\-\-yes\f[R] option is assumed by
commands that support it, meaning user confirmation prompts will be
automatically accepted for those operations (see \f[B]COMMANDS\f[R] to
determine which commands this applies to).
.SS Options
.TP
\f[B]-h,\f[R] \f[B]--help\f[R]
\f[B]\-h,\f[R] \f[B]\-\-help\f[R]
Print brief usage information
.TP
\f[B]-v,\f[R] \f[B]--version\f[R]
\f[B]\-v,\f[R] \f[B]\-\-version\f[R]
Print the current version string
.SH COMMANDS
.SS \f[B]create\f[R] \f[I]ponds\&...\f[R]
.PP
Create ponds \f[I]ponds\f[R].
An empty directory will be created in \f[B]$pond_home\f[R] for each
named pond.
.SS \f[B]remove\f[R] [\f[B]-y\f[R]|\f[B]--yes\f[R]] \f[I]ponds\&...\f[R]
.PP
.SS \f[B]remove\f[R] [\f[B]\-y\f[R]|\f[B]\-\-yes\f[R]] \f[I]ponds\&...\f[R]
Remove \f[I]ponds\f[R].
All pond data will be erased for each named pond.
Confirmation is requested from the user for each named pond and a
\f[B]yes\f[R] response confirms removal of the named pond.
Confirmation prompts can be automatically accepted with the
\f[B]--yes\f[R] option.
\f[B]\-\-yes\f[R] option.
.TP
\f[B]-y\f[R], \f[B]--yes\f[R]
\f[B]\-y\f[R], \f[B]\-\-yes\f[R]
Automatically accept confirmation prompts (this option is inferred when
using \f[B]pond\f[R] in the context of a pipeline)
.SS \f[B]list\f[R] [\f[B]-e\f[R]|\f[B]--enabled\f[R]] [\f[B]-d\f[R]|\f[B]--disabled\f[R]] [\f[B]-l\f[R]|\f[B]--loaded\f[R]] [\f[B]-u\f[R]|\f[B]--unloaded\f[R]]
.PP
.SS \f[B]list\f[R] [\f[B]\-e\f[R]|\f[B]\-\-enabled\f[R]] [\f[B]\-d\f[R]|\f[B]\-\-disabled\f[R]] [\f[B]\-l\f[R]|\f[B]\-\-loaded\f[R]] [\f[B]\-u\f[R]|\f[B]\-\-unloaded\f[R]]
List ponds.
If no options are specified, \f[I]all\f[R] pond names will be printed to
standard output regardless of their status.
If one or more options are specified, then only the names of ponds that
match an option will be output.
.TP
\f[B]-e\f[R], \f[B]--enabled\f[R]
\f[B]\-e\f[R], \f[B]\-\-enabled\f[R]
List enabled ponds
.TP
\f[B]-d\f[R], \f[B]--disabled\f[R]
\f[B]\-d\f[R], \f[B]\-\-disabled\f[R]
List disabled ponds
.TP
\f[B]-l\f[R], \f[B]--loaded\f[R]
\f[B]\-l\f[R], \f[B]\-\-loaded\f[R]
List loaded ponds
.TP
\f[B]-u\f[R], \f[B]--unloaded\f[R]
\f[B]\-u\f[R], \f[B]\-\-unloaded\f[R]
List unloaded ponds
.PP
\f[I]Example:\f[R] \f[B]pond list\f[R] (list all ponds)
.PP
\f[I]Example:\f[R] \f[B]pond list --disabled\f[R] (list disabled ponds
\f[I]Example:\f[R] \f[B]pond list \-\-disabled\f[R] (list disabled ponds
only)
.PP
\f[I]Example:\f[R] \f[B]pond list --enabled --unloaded\f[R] (list
\f[I]Example:\f[R] \f[B]pond list \-\-enabled \-\-unloaded\f[R] (list
enabled \f[I]and\f[R] unloaded ponds only)
.SS \f[B]check\f[R] \f[I]ponds\&...\f[R]
.PP
Check \f[I]ponds\f[R] for syntax issues.
A list of function filenames will be printed, one filename per line, for
each named pond.
Expand All @@ -106,7 +99,6 @@ failures, and total function count for the pond.
This command will exit early if syntax issues are found, after the first
pond with failures.
.SS \f[B]autoload\f[R] \f[I]pond\f[R]
.PP
Open the autoload function for \f[I]pond\f[R] in an interactive editor.
The function will be created if it does not already exist and will be
named after \f[I]pond\f[R] with the suffix _autoload.
Expand All @@ -120,7 +112,6 @@ See \f[B]ENVIRONMENT\f[R] for a discussion of the \f[B]pond_editor\f[R]
\f[I]universal\f[R] variable that controls which editor is used when
this command is invoked.
.SS \f[B]autounload\f[R] \f[I]pond\f[R]
.PP
Open the autounload function for \f[I]pond\f[R] in an interactive
editor.
The function will be created if it does not already exist and will be
Expand All @@ -138,34 +129,29 @@ See \f[B]ENVIRONMENT\f[R] for a discussion of the \f[B]pond_editor\f[R]
\f[I]universal\f[R] variable that controls which editor is used when
this command is invoked.
.SS \f[B]enable\f[R] \f[I]ponds\&...\f[R]
.PP
Enable \f[I]ponds\f[R].
The path of each named pond will be added to the
\f[B]$fish_function_path\f[R] environment variable in new shells.
Functions belonging to a pond may be autoloaded by name if a pond was
enabled before the shell was created.
.SS \f[B]disable\f[R] \f[I]ponds\&...\f[R]
.PP
Disable \f[I]ponds\f[R].
The path of each named pond will not be added to the
\f[B]$fish_function_path\f[R] environment variable in new shells.
Functions belonging to a pond will be inaccessible in new shells.
.SS \f[B]load\f[R] \f[I]ponds\&...\f[R]
.PP
Load \f[I]ponds\f[R].
The path of each named pond will be added to the
\f[B]$fish_function_path\f[R] environment variable in the current shell.
Functions belonging to \f[I]ponds\f[R] may be autoloaded by name in the
current shell.
.SS \f[B]unload\f[R] \f[I]ponds\&...\f[R]
.PP
Unload \f[I]ponds\f[R].
The path of each named pond will be remove from the
\f[B]$fish_function_path\f[R] environment variable in the current shell.
Functions belonging to \f[I]ponds\f[R] will be inaccessible in the
current shell.
.SS \f[B]status\f[R] [\f[I]ponds\&...\f[R]]
.PP
View global status (without arguments) or status of the specified
\f[I]ponds\f[R].
.PP
Expand Down Expand Up @@ -214,8 +200,7 @@ The number of functions in the pond
.TP
\f[B]Size\f[R]
The size of the pond and unit suffix
.SS \f[B]drain\f[R] [\f[B]-y\f[R]|\f[B]--yes\f[R]] \f[I]ponds\&...\f[R]
.PP
.SS \f[B]drain\f[R] [\f[B]\-y\f[R]|\f[B]\-\-yes\f[R]] \f[I]ponds\&...\f[R]
Drain \f[I]ponds\f[R].
All functions are removed from each named pond.
If any of the named ponds was enabled for the current shell session or
Expand All @@ -224,18 +209,15 @@ had been previously loaded in the current shell session with the
the shell environment and continue to be accessible to processes until
the current shell exits.
.TP
\f[B]-y\f[R], \f[B]--yes\f[R]
\f[B]\-y\f[R], \f[B]\-\-yes\f[R]
Automatically accept confirmation prompts (this option is inferred when
using \f[B]pond\f[R] in the context of a pipeline)
.SS \f[B]dir\f[R] \f[I]pond\f[R]
.PP
Change the current working directory to the pond directory for
\f[I]pond\f[R].
.SS \f[B]config\f[R]
.PP
Print the current configuration settings.
.SH ENVIRONMENT
.PP
A number of \f[I]universal\f[R] shell variables (see \f[B]set\f[R](1)
for discussion of \f[I]universal\f[R] variables) are set during
installation.
Expand Down Expand Up @@ -277,14 +259,12 @@ To disable this behaviour set the value of this variable to
\f[I]Default:\f[R] \f[B]yes\f[R].
.RE
.SH EXIT STATUS
.PP
\f[B]pond\f[R] exits 0 on success, and >0 if an error occurs.
.SH BUGS
.PP
See GitHub Issues: https://github.com/marcransome/pond/issues
.SH AUTHOR
.PP
Marc Ransome <[email protected]>
Marc Ransome \c
.MT [email protected]
.ME \c
.SH SEE ALSO
.PP
fish(1), fish-doc(1), fish-completions(1), function(1), set(1)
fish(1), fish\-doc(1), fish\-completions(1), function(1), set(1)
Loading

0 comments on commit e54b0ae

Please sign in to comment.