]> git.ipfire.org Git - thirdparty/ccache.git/commitdiff
Man page tweaks
authorJoel Rosdahl <joel@rosdahl.net>
Sat, 27 Feb 2010 12:23:54 +0000 (13:23 +0100)
committerJoel Rosdahl <joel@rosdahl.net>
Sat, 27 Feb 2010 12:23:54 +0000 (13:23 +0100)
ccache.yo

index f802dca3687870160c8474f02269d55e493fd1e4..4a093224efed22af940a33d0e8ae4a74eddcbd35 100644 (file)
--- a/ccache.yo
+++ b/ccache.yo
@@ -17,7 +17,7 @@ being done again.
 
 manpagesection(OPTIONS SUMMARY)
 
-Here is a summary of the options to ccache.
+Here is a summary of the options to ccache:
 
 verb(
 -c, --cleanup         run a cache cleanup
@@ -40,8 +40,14 @@ invoked as a compiler none of these options apply. In that case your
 normal compiler options apply and you should refer to your compilers
 documentation.
 
+Some of the command line options have two variants (one short and one long).
+These are shown below, separated by commas. Some options only have a long
+variant. The '=' for options that take a parameter is optional; whitespace can
+be used instead. If there is an argument to the option, it must be given to the
+short option variant as well.
+
 startdit()
-dit(bf(-c, --cleanup)) Clean the cache and re-calculate the cache file
+dit(bf(-c, --cleanup)) Clean the cache and recalculate the cache file
 count and size totals. Normally the -c option should not be necessary
 as ccache keeps the cache below the specified limits at runtime and
 keeps statistics up to date on each compile. This option is mostly
@@ -51,13 +57,13 @@ cache size statistics may be inaccurate.
 dit(bf(-C, --clear)) Clear the entire cache, removing all cached
 files.
 
-dit(bf(-F <maxfiles>, --max-files=<maxfiles>)) This sets the maximum
+dit(bf(-F, --max-files=N)) This sets the maximum
 number of object files allowed in the cache. The value is stored
 inside the cache directory and applies to all future compiles. Due to
 the way the value is stored the actual value used is always rounded
 down to the nearest multiple of 16.
 
-dit(bf(-M <maxsize>, --max-size=<maxsize>)) This sets the maximum size
+dit(bf(-M, --max-size=SIZE)) This sets the maximum size
 of the object files stored in the cache. You can specify a value in
 gigabytes, megabytes or kilobytes by appending a G, M or K to the
 value. The default is gigabytes. The actual value stored is rounded