Describe what -X/--vacuum really does

akrennmair · Feb 4, 2017 · 4afc48e · 4afc48e
1 parent 77bfb88
commit 4afc48e
Show file tree

Hide file tree

Showing 3 changed files with 7 additions and 3 deletions.
diff --git a/doc/chapter-firststeps.txt b/doc/chapter-firststeps.txt
@@ -11,7 +11,7 @@ After you've installed newsbeuter, you can run it for the first time by typing
 		-u, --url-file=<urlfile>        read RSS feed URLs from <urlfile>
 		-c, --cache-file=<cachefile>    use <cachefile> as cache file
 		-C, --config-file=<configfile>  read configuration from <configfile>
-		-X, --vacuum                    clean up cache thoroughly
+		-X, --vacuum                    compact the cache
 		-x, --execute=<command>...      execute list of commands
 		-q, --quiet                     quiet startup
 		-v, --version                   get version information

diff --git a/doc/manpage-newsbeuter.txt b/doc/manpage-newsbeuter.txt
@@ -33,7 +33,11 @@ OPTIONS
         Export feeds as OPML to stdout
 
 -X, --vacuum::
-        Clean up cache thoroughly (i.e. reduce it in size if possible)
+        Compact the cache by: 1) reclaiming the space that was left empty when
+        data was deleted; and 2) defragmenting the entries in the cache. This
+        *doesn't* delete the entries; for that, see 'cleanup-on-quit',
+        'delete-read-articles-on-quit', 'keep-articles-days', and 'max-items'
+        settings.
 
 -v, -V, --version::
         Get version information about newsbeuter and the libraries it uses

diff --git a/src/controller.cpp b/src/controller.cpp
@@ -1020,7 +1020,7 @@ void controller::usage(char * argv0) {
 		{ 'u', "url-file"        , _s("<urlfile>")   , _s("read RSS feed URLs from <urlfile>") }                                          ,
 		{ 'c', "cache-file"      , _s("<cachefile>") , _s("use <cachefile> as cache file") }                                              ,
 		{ 'C', "config-file"     , _s("<configfile>"), _s("read configuration from <configfile>") }                                       ,
-		{ 'X', "vacuum"          , ""                , _s("clean up cache thoroughly") }                                                  ,
+		{ 'X', "vacuum"          , ""                , _s("compact the cache") }                                                  ,
 		{ 'x', "execute"         , _s("<command>..."), _s("execute list of commands") }                                                   ,
 		{ 'q', "quiet"           , ""                , _s("quiet startup") }                                                              ,
 		{ 'v', "version"         , ""                , _s("get version information") }                                                    ,