Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
ISPN-2739 Document the encoding command correctly
- Loading branch information
1 parent
f606ad9
commit e88ca42
Showing
1 changed file
with
8 additions
and
4 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,9 +1,13 @@ | ||
.SH SYNOPSIS | ||
.B encoding [ | ||
.I cachename | ||
.I --list | | ||
.I codec | ||
.B ] | ||
.SH DESCRIPTION | ||
Shows the currently selected cache or selects a cache to be used as default for CLI operations | ||
The encoding command is used to set a default codec to use when reading/writing entries from/to a cache. When invoked | ||
without arguments it shows the currently selected codec. | ||
.SH ARGUMENTS | ||
.IP cachename | ||
(optional) the name of the cache to set as default for the following operations | ||
.IP --list | ||
shows a list of available codecs | ||
.IP codec | ||
specifies the default codec to use for all subsequent operations on caches |