summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
-rw-r--r--README.rst55
1 files changed, 27 insertions, 28 deletions
diff --git a/README.rst b/README.rst
index 922e2bf..58ec09a 100644
--- a/README.rst
+++ b/README.rst
@@ -7,11 +7,11 @@ setcolors_ utility.
Usage
-----
-**vtcol** knows two ways of loading a color scheme: Either by picking the
-definitions for a set of predefined schemes or by loading it from a definition
-file. The latter accepts input in the format supported by setcolors_. NB not
-much effort has been put into ensuring compliance so YMMV. Check the
-subdirectory ``./schemes`` in the **vtcol** tree for examples.
+**vtcol** knows two ways of loading a color scheme: From a set of predefined
+palettes or by loading it from a definition file. The latter accepts input in
+the format supported by setcolors_. (Not much effort has been put into ensuring
+compliance so YMMV.) Check the subdirectory ``./schemes`` in the **vtcol** tree
+for examples of definition files.
Three color schemes are predefined:
@@ -19,44 +19,43 @@ Three color schemes are predefined:
* ``solarized`` the Solarized_ color scheme, dark version.
* ``solarized_light`` the Solarized_ color scheme, light version.
-Invoke **vtcol** with the ``--scheme`` option specifying the scheme of your
-choice:
+Invoke **vtcol** with the ``set`` command specifying the scheme of your
+choice: ::
-::
+ $ vtcol set solarized_light
- vtcol --scheme solarized_light
-
-In order to view the available schemes, use the ``--list`` option. Should the
+In order to view the available schemes, use the ``list`` command. Should the
scheme specified not resolve to one of the predefined ones, **vtcol** will fall
-back to interpreting the name as that of a file. Likewise, loading a scheme
+back on interpreting the name as that of a file. Likewise, loading a scheme
directly from a definition file is accomplished by specifying the ``--file``
-argument.
-
-::
+argument to ``set``. ::
- vtcol --file ./schemes/solarized
+ $ vtcol set --file ./schemes/solarized
Instead of an actual scheme or file name, these parameters accept ``-``
-as an argument in order to read from ``stdin``.
+as an argument in order to read from ``stdin``. ::
+
+ $ vtcol set -
-Also, in order to view a scheme’s definition, for instance in order to verify
-that **vtcol** parses it correctly, specify the ``--dump`` option.
+To show the current scheme of the active console use the ``get`` subcommand: ::
-::
+ $ vtcol get
+ solarized_dark
- vtcol --dump default
- vtcol --dump ./schemes/solarized
+To view a scheme’s definition, for instance in order to verify that **vtcol**
+parses it correctly, use the ``dump`` command. ::
-This will print the list of color definitions as dictated by the scheme; if the
-specified name does not resolve to a pre-defined scheme it will be interpreted
-as a file name instead.
+ $ vtcol dump default
+ $ vtcol dump ./schemes/solarized
+
+This will print the color definitions contained in the scheme; if the specified
+name does not resolve to a pre-defined scheme it will be interpreted as a file
+name instead.
Building
--------
-Use Cargo to obtain a binary:
-
-::
+Use Cargo to obtain a binary: ::
cargo build