Updated readme to replace --debug with --index
This commit is contained in:
parent
c0265d2a6e
commit
6fea978459
11
README.md
11
README.md
|
@ -78,17 +78,16 @@ The cache can be regenerated at any time by accessing the `/clear_cache` endpoin
|
||||||
|
|
||||||
If `--cache-file` is set, the cache will be loaded from the specified file on start, and written to the file whenever it is re-generated.
|
If `--cache-file` is set, the cache will be loaded from the specified file on start, and written to the file whenever it is re-generated.
|
||||||
|
|
||||||
|
If the `-i|--index` flag is passed, two additional endpoints—`/html` and `/json`—are registered.
|
||||||
|
|
||||||
|
When accessed, these endpoints return the contents of the index, in HTML and JSON formats respectively. This can prove useful when confirming whether the index is generated successfully, or whether a given file is in the index.
|
||||||
|
|
||||||
## Statistics
|
## Statistics
|
||||||
|
|
||||||
If the `--stats` flag is passed, an additional endpoint, `/stats`, is registered.
|
If the `--stats` flag is passed, an additional endpoint, `/stats`, is registered.
|
||||||
|
|
||||||
When accessed, this endpoint returns a JSON document listing every file served, along with the number of times it has been served, its filesize, and timestamps of when it was served.
|
When accessed, this endpoint returns a JSON document listing every file served, along with the number of times it has been served, its filesize, and timestamps of when it was served.
|
||||||
|
|
||||||
## Debug
|
|
||||||
If the `-d|--debug` flag is passed, two additional endpoints—`/html` and `/json`—are registered.
|
|
||||||
|
|
||||||
When accessed, these endpoints return the contents of the index, in HTML and JSON formats respectively. This can prove useful when confirming whether the index is generated successfully, or whether a given file is in the index.
|
|
||||||
|
|
||||||
## Russian
|
## Russian
|
||||||
If the `--russian` flag is passed, everything functions exactly as you would expect.
|
If the `--russian` flag is passed, everything functions exactly as you would expect.
|
||||||
|
|
||||||
|
@ -114,7 +113,7 @@ Flags:
|
||||||
-c, --cache generate directory cache at startup
|
-c, --cache generate directory cache at startup
|
||||||
--cache-file string path to optional persistent cache file
|
--cache-file string path to optional persistent cache file
|
||||||
-f, --filter enable filtering
|
-f, --filter enable filtering
|
||||||
--flash enable support for shockwave flash files (via ruffle) (default true)
|
--flash enable support for shockwave flash files (via ruffle.rs) (default true)
|
||||||
-h, --help help for roulette
|
-h, --help help for roulette
|
||||||
--images enable support for image files (default true)
|
--images enable support for image files (default true)
|
||||||
-i, --index expose index endpoints
|
-i, --index expose index endpoints
|
||||||
|
|
|
@ -88,7 +88,7 @@ func init() {
|
||||||
rootCmd.Flags().BoolVarP(&Cache, "cache", "c", false, "generate directory cache at startup")
|
rootCmd.Flags().BoolVarP(&Cache, "cache", "c", false, "generate directory cache at startup")
|
||||||
rootCmd.Flags().StringVar(&CacheFile, "cache-file", "", "path to optional persistent cache file")
|
rootCmd.Flags().StringVar(&CacheFile, "cache-file", "", "path to optional persistent cache file")
|
||||||
rootCmd.Flags().BoolVarP(&Filtering, "filter", "f", false, "enable filtering")
|
rootCmd.Flags().BoolVarP(&Filtering, "filter", "f", false, "enable filtering")
|
||||||
rootCmd.Flags().BoolVar(&Flash, "flash", false, "enable support for shockwave flash files (via ruffle)")
|
rootCmd.Flags().BoolVar(&Flash, "flash", false, "enable support for shockwave flash files (via ruffle.rs)")
|
||||||
rootCmd.Flags().BoolVar(&Images, "images", false, "enable support for image files")
|
rootCmd.Flags().BoolVar(&Images, "images", false, "enable support for image files")
|
||||||
rootCmd.Flags().BoolVarP(&Index, "index", "i", false, "expose index endpoints")
|
rootCmd.Flags().BoolVarP(&Index, "index", "i", false, "expose index endpoints")
|
||||||
rootCmd.Flags().Uint64Var(&MaximumFileCount, "maximum-files", 1<<64-1, "skip directories with file counts above this value")
|
rootCmd.Flags().Uint64Var(&MaximumFileCount, "maximum-files", 1<<64-1, "skip directories with file counts above this value")
|
||||||
|
|
Loading…
Reference in New Issue