Skip to content

Commit

Permalink
Merge pull request #142 from marcransome/man-update
Browse files Browse the repository at this point in the history
Use consistent format for variable references
  • Loading branch information
marcransome authored Sep 16, 2023
2 parents 4b1a267 + 0c7c1df commit 8e72334
Show file tree
Hide file tree
Showing 3 changed files with 12 additions and 12 deletions.
8 changes: 4 additions & 4 deletions docs/pond.1
Original file line number Diff line number Diff line change
Expand Up @@ -141,27 +141,27 @@ this command is invoked.
.PP
Enable \f[I]ponds\f[R].
The path of each named pond will be added to the
\f[I]$fish_function_path\f[R] environment variable in new shells.
\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[I]$fish_function_path\f[R] environment variable in new shells.
\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[I]$fish_function_path\f[R] environment variable in the current shell.
\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[I]$fish_function_path\f[R] environment variable in the current shell.
\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]]
Expand Down
8 changes: 4 additions & 4 deletions docs/pond.html
Original file line number Diff line number Diff line change
Expand Up @@ -213,13 +213,13 @@ <h2 id="autounload-pond"><strong>autounload</strong> <em>pond</em></h2>
<p>If <em>pond</em> is unloaded (see <strong>unload</strong>) the function will be executed automatically. It is advisable to use the autounload function to perform cleanup of any operations present in a pond’s autoload function, if one exists. For example, unsetting environment variables that were previously set. Doing so will ensure that unloading a pond (see <strong>unload</strong>) will remove any configuration for a pond from the shell environment.</p>
<p>See <strong>ENVIRONMENT</strong> for a discussion of the <strong>pond_editor</strong> <em>universal</em> variable that controls which editor is used when this command is invoked.</p>
<h2 id="enable-ponds"><strong>enable</strong> <em>ponds…</em></h2>
<p>Enable <em>ponds</em>. The path of each named pond will be added to the <em>$fish_function_path</em> 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.</p>
<p>Enable <em>ponds</em>. The path of each named pond will be added to the <strong>$fish_function_path</strong> 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.</p>
<h2 id="disable-ponds"><strong>disable</strong> <em>ponds…</em></h2>
<p>Disable <em>ponds</em>. The path of each named pond will not be added to the <em>$fish_function_path</em> environment variable in new shells. Functions belonging to a pond will be inaccessible in new shells.</p>
<p>Disable <em>ponds</em>. The path of each named pond will not be added to the <strong>$fish_function_path</strong> environment variable in new shells. Functions belonging to a pond will be inaccessible in new shells.</p>
<h2 id="load-ponds"><strong>load</strong> <em>ponds…</em></h2>
<p>Load <em>ponds</em>. The path of each named pond will be added to the <em>$fish_function_path</em> environment variable in the current shell. Functions belonging to <em>ponds</em> may be autoloaded by name in the current shell.</p>
<p>Load <em>ponds</em>. The path of each named pond will be added to the <strong>$fish_function_path</strong> environment variable in the current shell. Functions belonging to <em>ponds</em> may be autoloaded by name in the current shell.</p>
<h2 id="unload-ponds"><strong>unload</strong> <em>ponds…</em></h2>
<p>Unload <em>ponds</em>. The path of each named pond will be remove from the <em>$fish_function_path</em> environment variable in the current shell. Functions belonging to <em>ponds</em> will be inaccessible in the current shell.</p>
<p>Unload <em>ponds</em>. The path of each named pond will be remove from the <strong>$fish_function_path</strong> environment variable in the current shell. Functions belonging to <em>ponds</em> will be inaccessible in the current shell.</p>
<h2 id="status-ponds"><strong>status</strong> [<em>ponds…</em>]</h2>
<p>View global status (without arguments) or status of the specified <em>ponds</em>.</p>
<p>The global status output includes a visual representation of the overall health of all ponds in the form of a leading dot symbol. The dot is coloured green or red to indicate the absence or presence of syntax issues in functions belonging to any ponds. This is followed by the version number of the pond command and a number of additional fields:</p>
Expand Down
8 changes: 4 additions & 4 deletions docs/pond.md
Original file line number Diff line number Diff line change
Expand Up @@ -107,22 +107,22 @@ See **ENVIRONMENT** for a discussion of the **pond\_editor** _universal_ variabl
**enable** _ponds..._
---------------------

Enable _ponds_. The path of each named pond will be added to the *\$fish\_function\_path* 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.
Enable _ponds_. The path of each named pond will be added to the **\$fish\_function\_path** 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.

**disable** _ponds..._
----------------------

Disable _ponds_. The path of each named pond will not be added to the *\$fish\_function\_path* environment variable in new shells. Functions belonging to a pond will be inaccessible in new shells.
Disable _ponds_. The path of each named pond will not be added to the **\$fish\_function\_path** environment variable in new shells. Functions belonging to a pond will be inaccessible in new shells.

**load** _ponds..._
-------------------

Load _ponds_. The path of each named pond will be added to the *\$fish\_function\_path* environment variable in the current shell. Functions belonging to _ponds_ may be autoloaded by name in the current shell.
Load _ponds_. The path of each named pond will be added to the **\$fish\_function\_path** environment variable in the current shell. Functions belonging to _ponds_ may be autoloaded by name in the current shell.

**unload** _ponds..._
---------------------

Unload _ponds_. The path of each named pond will be remove from the *\$fish\_function\_path* environment variable in the current shell. Functions belonging to _ponds_ will be inaccessible in the current shell.
Unload _ponds_. The path of each named pond will be remove from the **\$fish\_function\_path** environment variable in the current shell. Functions belonging to _ponds_ will be inaccessible in the current shell.

**status** [_ponds..._]
-----------------------
Expand Down

0 comments on commit 8e72334

Please sign in to comment.