Skip to content

Commit

Permalink
ISPN-2739 Document the encoding command correctly
Browse files Browse the repository at this point in the history
  • Loading branch information
tristantarrant authored and galderz committed Jan 24, 2013
1 parent f606ad9 commit e88ca42
Showing 1 changed file with 8 additions and 4 deletions.
12 changes: 8 additions & 4 deletions cli/cli-client/src/main/resources/help/encoding.txt
@@ -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

0 comments on commit e88ca42

Please sign in to comment.