You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@lucenenet.apache.org by ni...@apache.org on 2021/03/30 15:05:28 UTC
[lucenenet] 01/15: docs: lucene-cli: Fixed command formatting and
warnings to use DocFx formatting
This is an automated email from the ASF dual-hosted git repository.
nightowl888 pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/lucenenet.git
commit 294771827fbb7770c1d936fdc1231fcd49ea97bc
Author: Shad Storhaug <sh...@shadstorhaug.com>
AuthorDate: Tue Mar 30 19:15:45 2021 +0700
docs: lucene-cli: Fixed command formatting and warnings to use DocFx formatting
---
.../lucene-cli/docs/analysis/kuromoji-build-dictionary.md | 8 ++++++--
.../lucene-cli/docs/analysis/stempel-compile-stems.md | 8 ++++++--
.../tools/lucene-cli/docs/analysis/stempel-patch-stems.md | 8 ++++++--
.../tools/lucene-cli/docs/benchmark/extract-reuters.md | 8 ++++++--
.../tools/lucene-cli/docs/benchmark/extract-wikipedia.md | 8 ++++++--
.../lucene-cli/docs/benchmark/find-quality-queries.md | 8 ++++++--
.../tools/lucene-cli/docs/benchmark/run-trec-eval.md | 4 +++-
src/dotnet/tools/lucene-cli/docs/benchmark/run.md | 8 ++++++--
src/dotnet/tools/lucene-cli/docs/benchmark/sample.md | 8 ++++++--
.../tools/lucene-cli/docs/demo/associations-facets.md | 8 ++++++--
src/dotnet/tools/lucene-cli/docs/demo/distance-facets.md | 8 ++++++--
.../lucene-cli/docs/demo/expression-aggregation-facets.md | 8 ++++++--
src/dotnet/tools/lucene-cli/docs/demo/index-files.md | 8 +++++---
.../lucene-cli/docs/demo/multi-category-lists-facets.md | 8 ++++++--
src/dotnet/tools/lucene-cli/docs/demo/range-facets.md | 8 ++++++--
src/dotnet/tools/lucene-cli/docs/demo/search-files.md | 12 ++++++++----
src/dotnet/tools/lucene-cli/docs/demo/simple-facets.md | 8 ++++++--
.../lucene-cli/docs/demo/simple-sorted-set-facets.md | 8 ++++++--
src/dotnet/tools/lucene-cli/docs/index.md | 9 ++++++---
src/dotnet/tools/lucene-cli/docs/index/check.md | 12 +++++++++---
src/dotnet/tools/lucene-cli/docs/index/copy-segments.md | 8 ++++++--
src/dotnet/tools/lucene-cli/docs/index/delete-segments.md | 13 ++++++++++---
src/dotnet/tools/lucene-cli/docs/index/extract-cfs.md | 12 +++++++++---
src/dotnet/tools/lucene-cli/docs/index/fix.md | 11 ++++++++---
src/dotnet/tools/lucene-cli/docs/index/index.md | 3 ++-
src/dotnet/tools/lucene-cli/docs/index/list-cfs.md | 8 ++++++--
.../tools/lucene-cli/docs/index/list-high-freq-terms.md | 13 +++++++++----
src/dotnet/tools/lucene-cli/docs/index/list-segments.md | 8 ++++++--
.../tools/lucene-cli/docs/index/list-taxonomy-stats.md | 11 ++++++++---
src/dotnet/tools/lucene-cli/docs/index/list-term-info.md | 8 ++++++--
src/dotnet/tools/lucene-cli/docs/index/merge.md | 8 ++++++--
src/dotnet/tools/lucene-cli/docs/index/split.md | 15 +++++++++++----
src/dotnet/tools/lucene-cli/docs/index/upgrade.md | 15 +++++++++++----
src/dotnet/tools/lucene-cli/docs/lock/stress-test.md | 8 ++++++--
src/dotnet/tools/lucene-cli/docs/lock/verify-server.md | 8 ++++++--
35 files changed, 231 insertions(+), 83 deletions(-)
diff --git a/src/dotnet/tools/lucene-cli/docs/analysis/kuromoji-build-dictionary.md b/src/dotnet/tools/lucene-cli/docs/analysis/kuromoji-build-dictionary.md
index 6fa08fe..7dfc989 100644
--- a/src/dotnet/tools/lucene-cli/docs/analysis/kuromoji-build-dictionary.md
+++ b/src/dotnet/tools/lucene-cli/docs/analysis/kuromoji-build-dictionary.md
@@ -6,7 +6,9 @@
### Synopsis
-<code>lucene analysis kuromoji-build-dictionary \<FORMAT> \<INPUT_DIRECTORY> \<OUTPUT_DIRECTORY> [-e|--encoding] [-n|--normalize] [?|-h|--help]</code>
+```console
+lucene analysis kuromoji-build-dictionary <FORMAT> <INPUT_DIRECTORY> <OUTPUT_DIRECTORY> [-e|--encoding] [-n|--normalize] [?|-h|--help]
+```
### Description
@@ -56,5 +58,7 @@ Normalize the entries using normalization form KC.
### Example
-<code>lucene analysis kuromoji-build-dictionary IPADIC X:\kuromoji-data X:\kuromoji-dictionary --normalize</code>
+```console
+lucene analysis kuromoji-build-dictionary IPADIC X:\kuromoji-data X:\kuromoji-dictionary --normalize
+```
diff --git a/src/dotnet/tools/lucene-cli/docs/analysis/stempel-compile-stems.md b/src/dotnet/tools/lucene-cli/docs/analysis/stempel-compile-stems.md
index 01ccdf6..9138e63 100644
--- a/src/dotnet/tools/lucene-cli/docs/analysis/stempel-compile-stems.md
+++ b/src/dotnet/tools/lucene-cli/docs/analysis/stempel-compile-stems.md
@@ -6,7 +6,9 @@
### Synopsis
-<code>lucene analysis stempel-compile-stems \<STEMMING_ALGORITHM> \<STEMMER_TABLE_FILE> [-e|--encoding] [?|-h|--help]</code>
+```console
+lucene analysis stempel-compile-stems <STEMMING_ALGORITHM> <STEMMER_TABLE_FILE> [-e|--encoding] [?|-h|--help]
+```
### Description
@@ -34,4 +36,6 @@ The file encoding used by the stemmer files. If not supplied, the default value
### Example
-<code>lucene analysis stempel-compile-stems test X:\stemmer-data\table1.txt X:\stemmer-data\table2.txt</code>
+```console
+lucene analysis stempel-compile-stems test X:\stemmer-data\table1.txt X:\stemmer-data\table2.txt
+```
diff --git a/src/dotnet/tools/lucene-cli/docs/analysis/stempel-patch-stems.md b/src/dotnet/tools/lucene-cli/docs/analysis/stempel-patch-stems.md
index 18cff3a..0d5e38f 100644
--- a/src/dotnet/tools/lucene-cli/docs/analysis/stempel-patch-stems.md
+++ b/src/dotnet/tools/lucene-cli/docs/analysis/stempel-patch-stems.md
@@ -6,7 +6,9 @@
### Synopsis
-<code>lucene analysis stempel-patch-stems \<STEMMER_TABLE_FILE> [-e|--encoding] [?|-h|--help]</code>
+```console
+lucene analysis stempel-patch-stems <STEMMER_TABLE_FILE> [-e|--encoding] [?|-h|--help]
+```
### Description
@@ -30,5 +32,7 @@ The file encoding used by the stemmer files. If not supplied, the default value
### Example
-<code>lucene analysis stempel-patch-stems X:\stemmer-data\table1.txt X:\stemmer-data\table2.txt --encoding UTF-16</code>
+```console
+lucene analysis stempel-patch-stems X:\stemmer-data\table1.txt X:\stemmer-data\table2.txt --encoding UTF-16
+```
diff --git a/src/dotnet/tools/lucene-cli/docs/benchmark/extract-reuters.md b/src/dotnet/tools/lucene-cli/docs/benchmark/extract-reuters.md
index 892b5d0..a534dd5 100644
--- a/src/dotnet/tools/lucene-cli/docs/benchmark/extract-reuters.md
+++ b/src/dotnet/tools/lucene-cli/docs/benchmark/extract-reuters.md
@@ -6,7 +6,9 @@
### Synopsis
-<code>lucene benchmark extract-reuters \<INPUT_DIRECTORY> \<OUTPUT_DIRECTORY> [?|-h|--help]</code>
+```console
+lucene benchmark extract-reuters <INPUT_DIRECTORY> <OUTPUT_DIRECTORY> [?|-h|--help]
+```
### Arguments
@@ -28,4 +30,6 @@ Prints out a short help for the command.
Extracts the reuters SGML files in the `z:\input` directory and places the content in the `z:\output` directory.
-<code>lucene benchmark extract-reuters z:\input z:\output</code>
+```console
+lucene benchmark extract-reuters z:\input z:\output
+```
diff --git a/src/dotnet/tools/lucene-cli/docs/benchmark/extract-wikipedia.md b/src/dotnet/tools/lucene-cli/docs/benchmark/extract-wikipedia.md
index ccb27d2..310e0f7 100644
--- a/src/dotnet/tools/lucene-cli/docs/benchmark/extract-wikipedia.md
+++ b/src/dotnet/tools/lucene-cli/docs/benchmark/extract-wikipedia.md
@@ -6,7 +6,9 @@
### Synopsis
-<code>lucene benchmark extract-wikipedia \<INPUT_WIKIPEDIA_FILE> \<OUTPUT_DIRECTORY> [-d|--discard-image-only-docs] [?|-h|--help]</code>
+```console
+lucene benchmark extract-wikipedia <INPUT_WIKIPEDIA_FILE> <OUTPUT_DIRECTORY> [-d|--discard-image-only-docs] [?|-h|--help]
+```
### Arguments
@@ -32,4 +34,6 @@ Tells the extractor to skip WIKI docs that contain only images.
Extracts the `c:\wiki.xml` file into the `c:\out` directory, skipping any docs that only contain images.
-<code>lucene benchmark extract-wikipedia c:\wiki.xml c:\out -d</code>
+```console
+lucene benchmark extract-wikipedia c:\wiki.xml c:\out -d
+```
diff --git a/src/dotnet/tools/lucene-cli/docs/benchmark/find-quality-queries.md b/src/dotnet/tools/lucene-cli/docs/benchmark/find-quality-queries.md
index f1d4539..2709970 100644
--- a/src/dotnet/tools/lucene-cli/docs/benchmark/find-quality-queries.md
+++ b/src/dotnet/tools/lucene-cli/docs/benchmark/find-quality-queries.md
@@ -6,7 +6,9 @@
### Synopsis
-<code>lucene benchmark find-quality-queries \<INPUT_DIRECTORY> [?|-h|--help]</code>
+```console
+lucene benchmark find-quality-queries <INPUT_DIRECTORY> [?|-h|--help]
+```
### Arguments
@@ -24,4 +26,6 @@ Prints out a short help for the command.
Finds quality queries on the `c:\lucene-index` index directory.
-<code>lucene benchmark find-quality-queries c:\lucene-index</code>
+```console
+lucene benchmark find-quality-queries c:\lucene-index
+```
diff --git a/src/dotnet/tools/lucene-cli/docs/benchmark/run-trec-eval.md b/src/dotnet/tools/lucene-cli/docs/benchmark/run-trec-eval.md
index 0a22539..4f5fb64 100644
--- a/src/dotnet/tools/lucene-cli/docs/benchmark/run-trec-eval.md
+++ b/src/dotnet/tools/lucene-cli/docs/benchmark/run-trec-eval.md
@@ -6,7 +6,9 @@
### Synopsis
-<code>lucene benchmark run-trec-eval \<INPUT_TOPICS_FILE> \<INPUT_QUERY_RELEVANCE_FILE> \<OUTPUT_SUBMISSION_FILE> \<INDEX_DIRECTORY> [-t|--query-on-title] [-d|--query-on-description] [-n|--query-on-narrative] [?|-h|--help]</code>
+```console
+lucene benchmark run-trec-eval <INPUT_TOPICS_FILE> <INPUT_QUERY_RELEVANCE_FILE> <OUTPUT_SUBMISSION_FILE> <INDEX_DIRECTORY> [-t|--query-on-title] [-d|--query-on-description] [-n|--query-on-narrative] [?|-h|--help]
+```
### Arguments
diff --git a/src/dotnet/tools/lucene-cli/docs/benchmark/run.md b/src/dotnet/tools/lucene-cli/docs/benchmark/run.md
index c20cb85..d48ae4b 100644
--- a/src/dotnet/tools/lucene-cli/docs/benchmark/run.md
+++ b/src/dotnet/tools/lucene-cli/docs/benchmark/run.md
@@ -6,7 +6,9 @@
### Synopsis
-<code>lucene benchmark run \<ALGORITHM_FILE> \<OUTPUT_DIRECTORY> [?|-h|--help]</code>
+```console
+lucene benchmark run <ALGORITHM_FILE> <OUTPUT_DIRECTORY> [?|-h|--help]
+```
### Arguments
@@ -28,4 +30,6 @@ Prints out a short help for the command.
Runs a benchmark on the `c:\check.alg` algorithm file.
-<code>lucene benchmark run c:\check.alg</code>
+```console
+lucene benchmark run c:\check.alg
+```
diff --git a/src/dotnet/tools/lucene-cli/docs/benchmark/sample.md b/src/dotnet/tools/lucene-cli/docs/benchmark/sample.md
index e715ee4..245ef62 100644
--- a/src/dotnet/tools/lucene-cli/docs/benchmark/sample.md
+++ b/src/dotnet/tools/lucene-cli/docs/benchmark/sample.md
@@ -6,7 +6,9 @@
### Synopsis
-<code>lucene benchmark sample [-src|--view-source-code] [-out|--output-source-code] [?|-h|--help]</code>
+```console
+lucene benchmark sample [-src|--view-source-code] [-out|--output-source-code] [?|-h|--help]
+```
### Options
@@ -26,4 +28,6 @@ Outputs the source code to the specified directory.
Runs the sample.
-<code>lucene benchmark sample</code>
+```console
+lucene benchmark sample
+```
diff --git a/src/dotnet/tools/lucene-cli/docs/demo/associations-facets.md b/src/dotnet/tools/lucene-cli/docs/demo/associations-facets.md
index 1d5f9ce..282dbe8 100644
--- a/src/dotnet/tools/lucene-cli/docs/demo/associations-facets.md
+++ b/src/dotnet/tools/lucene-cli/docs/demo/associations-facets.md
@@ -6,7 +6,9 @@
### Synopsis
-<code>lucene demo associations-facets [-src|--view-source-code] [-out|--output-source-code] [?|-h|--help]</code>
+```console
+lucene demo associations-facets [-src|--view-source-code] [-out|--output-source-code] [?|-h|--help]
+```
### Options
@@ -24,4 +26,6 @@ Outputs the source code to the specified directory.
### Example
-<code>lucene demo associations-facets</code>
+```console
+lucene demo associations-facets
+```
diff --git a/src/dotnet/tools/lucene-cli/docs/demo/distance-facets.md b/src/dotnet/tools/lucene-cli/docs/demo/distance-facets.md
index 4631ea5..bafc515 100644
--- a/src/dotnet/tools/lucene-cli/docs/demo/distance-facets.md
+++ b/src/dotnet/tools/lucene-cli/docs/demo/distance-facets.md
@@ -6,7 +6,9 @@
### Synopsis
-<code>lucene demo distance-facets [-src|--view-source-code] [-out|--output-source-code] [?|-h|--help]</code>
+```console
+lucene demo distance-facets [-src|--view-source-code] [-out|--output-source-code] [?|-h|--help]
+```
### Options
@@ -24,4 +26,6 @@ Outputs the source code to the specified directory.
### Example
-<code>lucene demo distance-facets</code>
+```console
+lucene demo distance-facets
+```
diff --git a/src/dotnet/tools/lucene-cli/docs/demo/expression-aggregation-facets.md b/src/dotnet/tools/lucene-cli/docs/demo/expression-aggregation-facets.md
index 8dd0574..a101ed0 100644
--- a/src/dotnet/tools/lucene-cli/docs/demo/expression-aggregation-facets.md
+++ b/src/dotnet/tools/lucene-cli/docs/demo/expression-aggregation-facets.md
@@ -6,7 +6,9 @@
### Synopsis
-<code>lucene demo expression-aggregation-facets [-src|--view-source-code] [-out|--output-source-code] [?|-h|--help]</code>
+```console
+lucene demo expression-aggregation-facets [-src|--view-source-code] [-out|--output-source-code] [?|-h|--help]
+```
### Options
@@ -24,4 +26,6 @@ Outputs the source code to the specified directory.
### Example
-<code>lucene demo expression-aggregation-facets</code>
+```console
+lucene demo expression-aggregation-facets
+```
diff --git a/src/dotnet/tools/lucene-cli/docs/demo/index-files.md b/src/dotnet/tools/lucene-cli/docs/demo/index-files.md
index a4ceadb..a02484c 100644
--- a/src/dotnet/tools/lucene-cli/docs/demo/index-files.md
+++ b/src/dotnet/tools/lucene-cli/docs/demo/index-files.md
@@ -6,8 +6,8 @@
### Synopsis
-```
-lucene demo index-files \<INDEX_DIRECTORY> \<SOURCE_DIRECTORY> [-u|--update] [?|-h|--help]
+```console
+lucene demo index-files <INDEX_DIRECTORY> <SOURCE_DIRECTORY> [-u|--update] [?|-h|--help]
lucene demo index-files [-src|--view-source-code] [-out|--output-source-code]
```
@@ -47,5 +47,7 @@ Outputs the source code to the specified directory.
Indexes the contents of `C:\Users\BGates\Documents\` and places the Lucene.Net index in `X:\test-index\`.
-<code>lucene demo index-files X:\test-index C:\Users\BGates\Documents</code>
+```console
+lucene demo index-files X:\test-index C:\Users\BGates\Documents
+```
diff --git a/src/dotnet/tools/lucene-cli/docs/demo/multi-category-lists-facets.md b/src/dotnet/tools/lucene-cli/docs/demo/multi-category-lists-facets.md
index 299df60..299f7f9 100644
--- a/src/dotnet/tools/lucene-cli/docs/demo/multi-category-lists-facets.md
+++ b/src/dotnet/tools/lucene-cli/docs/demo/multi-category-lists-facets.md
@@ -6,7 +6,9 @@
### Synopsis
-<code>lucene demo multi-category-lists-facets [-src|--view-source-code] [-out|--output-source-code] [?|-h|--help]</code>
+```console
+lucene demo multi-category-lists-facets [-src|--view-source-code] [-out|--output-source-code] [?|-h|--help]
+```
### Options
@@ -25,4 +27,6 @@ Outputs the source code to the specified directory.
### Example
-<code>lucene demo multi-category-lists-facets</code>
+```console
+lucene demo multi-category-lists-facets
+```
diff --git a/src/dotnet/tools/lucene-cli/docs/demo/range-facets.md b/src/dotnet/tools/lucene-cli/docs/demo/range-facets.md
index f9b6121..e4fa1df 100644
--- a/src/dotnet/tools/lucene-cli/docs/demo/range-facets.md
+++ b/src/dotnet/tools/lucene-cli/docs/demo/range-facets.md
@@ -6,7 +6,9 @@
### Synopsis
-<code>lucene demo range-facets [-src|--view-source-code] [-out|--output-source-code] [?|-h|--help]</code>
+```console
+lucene demo range-facets [-src|--view-source-code] [-out|--output-source-code] [?|-h|--help]
+```
### Options
@@ -24,4 +26,6 @@ Outputs the source code to the specified directory.
### Example
-<code>lucene demo range-facets</code>
+```console
+lucene demo range-facets
+```
diff --git a/src/dotnet/tools/lucene-cli/docs/demo/search-files.md b/src/dotnet/tools/lucene-cli/docs/demo/search-files.md
index cbbeec1..a217ec8 100644
--- a/src/dotnet/tools/lucene-cli/docs/demo/search-files.md
+++ b/src/dotnet/tools/lucene-cli/docs/demo/search-files.md
@@ -6,8 +6,8 @@
### Synopsis
-```
-lucene demo search-files \<INDEX_DIRECTORY> [-f|--field] [-r|--repeat] [-qf|--queries-file] [-q|--query] [--raw] [-p|--page-size] [?|-h|--help]
+```console
+lucene demo search-files <INDEX_DIRECTORY> [-f|--field] [-r|--repeat] [-qf|--queries-file] [-q|--query] [--raw] [-p|--page-size] [?|-h|--help]
lucene demo search-files [-src|--view-source-code] [-out|--output-source-code]
```
@@ -65,8 +65,12 @@ Outputs the source code to the specified directory.
Search the index located in the `X:\test-index` directory interactively, showing 15 results per page in raw format:
-<code>lucene demo search-files X:\test-index -p 15 --raw</code>
+```console
+lucene demo search-files X:\test-index -p 15 --raw
+```
Run the query "foobar" against the "path" field in the index located in the `X:\test-index` directory:
-<code>lucene demo search-files X:\test-index --field path --query foobar</code>
+```console
+lucene demo search-files X:\test-index --field path --query foobar
+```
diff --git a/src/dotnet/tools/lucene-cli/docs/demo/simple-facets.md b/src/dotnet/tools/lucene-cli/docs/demo/simple-facets.md
index e93cc78..6ee2eb7 100644
--- a/src/dotnet/tools/lucene-cli/docs/demo/simple-facets.md
+++ b/src/dotnet/tools/lucene-cli/docs/demo/simple-facets.md
@@ -6,7 +6,9 @@
### Synopsis
-</code>lucene demo simple-facets [-src|--view-source-code] [-out|--output-source-code] [?|-h|--help]</code>
+```console
+lucene demo simple-facets [-src|--view-source-code] [-out|--output-source-code] [?|-h|--help]
+```
### Options
@@ -24,4 +26,6 @@ Outputs the source code to the specified directory.
### Example
-<code>lucene demo simple-facets</code>
+```console
+lucene demo simple-facets
+```
diff --git a/src/dotnet/tools/lucene-cli/docs/demo/simple-sorted-set-facets.md b/src/dotnet/tools/lucene-cli/docs/demo/simple-sorted-set-facets.md
index a92c9b9..fd25085 100644
--- a/src/dotnet/tools/lucene-cli/docs/demo/simple-sorted-set-facets.md
+++ b/src/dotnet/tools/lucene-cli/docs/demo/simple-sorted-set-facets.md
@@ -6,7 +6,9 @@
### Synopsis
-<code>lucene demo simple-sorted-set-facets [-src|--view-source-code] [-out|--output-source-code] [?|-h|--help]</code>
+```console
+lucene demo simple-sorted-set-facets [-src|--view-source-code] [-out|--output-source-code] [?|-h|--help]
+```
### Options
@@ -24,6 +26,8 @@ Outputs the source code to the specified directory.
### Example
-<code>lucene demo simple-sorted-set-facets</code>
+```console
+lucene demo simple-sorted-set-facets
+```
diff --git a/src/dotnet/tools/lucene-cli/docs/index.md b/src/dotnet/tools/lucene-cli/docs/index.md
index fad693d..55aedf9 100644
--- a/src/dotnet/tools/lucene-cli/docs/index.md
+++ b/src/dotnet/tools/lucene-cli/docs/index.md
@@ -10,11 +10,12 @@ The Lucene.NET command line interface (CLI) is a new cross-platform toolchain wi
Perform a one-time install of the lucene-cli tool using the following dotnet CLI command:
-```
+```console
dotnet tool install lucene-cli -g --version 4.8.0-beta00014
```
-> NOTE: The version of the CLI you install should match the version of Lucene.NET you use.
+> [!NOTE]
+> The version of the CLI you install should match the version of Lucene.NET you use.
You may then use the lucene-cli tool to analyze and update Lucene.NET indexes and use its demos.
@@ -31,7 +32,9 @@ The following commands are installed:
CLI command structure consists of the driver ("lucene"), the command, and possibly command arguments and options. You see this pattern in most CLI operations, such as checking a Lucene.NET index for problematic segments and fixing (removing) them:
-```
+```console
lucene index check C:\my-index --verbose
lucene index fix C:\my-index
```
+
+
diff --git a/src/dotnet/tools/lucene-cli/docs/index/check.md b/src/dotnet/tools/lucene-cli/docs/index/check.md
index aa35e04..b28cf14 100644
--- a/src/dotnet/tools/lucene-cli/docs/index/check.md
+++ b/src/dotnet/tools/lucene-cli/docs/index/check.md
@@ -6,7 +6,9 @@
### Synopsis
-<code>lucene index check [\<INDEX_DIRECTORY>] [-v|--verbose] [-c|--cross-check-term-vectors] [-dir|--directory-type] [-s|--segment] [?|-h|--help]</code>
+```console
+lucene index check [<INDEX_DIRECTORY>] [-v|--verbose] [-c|--cross-check-term-vectors] [-dir|--directory-type] [-s|--segment] [?|-h|--help]
+```
### Description
@@ -46,10 +48,14 @@ Only check the specified segment(s). This can be specified multiple times, to ch
Check the index located at `X:\lucenenet-index\` verbosely, scanning only the segments named `_1j_Lucene41_0` and `_2u_Lucene41_0` for problems:
-<code>lucene index check X:\lucenenet-index -v -s _1j_Lucene41_0 -s _2u_Lucene41_0</code>
+```console
+lucene index check X:\lucenenet-index -v -s _1j_Lucene41_0 -s _2u_Lucene41_0
+```
Check the index located at `C:\taxonomy\` using the `MMapDirectory` memory-mapped directory implementation:
-<code>lucene index check C:\taxonomy --directory-type MMapDirectory</code>
+```console
+lucene index check C:\taxonomy --directory-type MMapDirectory
+```
diff --git a/src/dotnet/tools/lucene-cli/docs/index/copy-segments.md b/src/dotnet/tools/lucene-cli/docs/index/copy-segments.md
index d4d1aa0..618f9cf 100644
--- a/src/dotnet/tools/lucene-cli/docs/index/copy-segments.md
+++ b/src/dotnet/tools/lucene-cli/docs/index/copy-segments.md
@@ -6,7 +6,9 @@
### Synopsis
-<code>lucene index copy-segments \<INPUT_DIRECTORY> \<OUTPUT_DIRECTORY> \<SEGMENT>[ \<SEGMENT_2>...] [?|-h|--help]</code>
+```console
+lucene index copy-segments <INPUT_DIRECTORY> <OUTPUT_DIRECTORY> <SEGMENT>[ <SEGMENT_2>...] [?|-h|--help]
+```
### Description
@@ -36,5 +38,7 @@ Prints out a short help for the command.
Copy the `_71_Lucene41_0` segment from the index located at `X:\lucene-index` to the index located at `X:\output`:
-<code>lucene index copy-segments X:\lucene-index X:\output _71_Lucene41_0</code>
+```console
+lucene index copy-segments X:\lucene-index X:\output _71_Lucene41_0
+```
diff --git a/src/dotnet/tools/lucene-cli/docs/index/delete-segments.md b/src/dotnet/tools/lucene-cli/docs/index/delete-segments.md
index c60c228..5eccbfd 100644
--- a/src/dotnet/tools/lucene-cli/docs/index/delete-segments.md
+++ b/src/dotnet/tools/lucene-cli/docs/index/delete-segments.md
@@ -6,11 +6,16 @@
### Synopsis
-<code>lucene index delete-segments \<INDEX_DIRECTORY> \<SEGMENT>[ \<SEGMENT_2>...] [?|-h|--help]</code>
+```console
+lucene index delete-segments <INDEX_DIRECTORY> <SEGMENT>[ <SEGMENT_2>...] [?|-h|--help]
+```
### Description
-You can easily accidentally remove segments from your index, so be careful! Always make a backup of your index first.
+Deletes segments from an index.
+
+> [!WARNING]
+> You can easily accidentally remove segments from your index, so be careful! Always make a backup of your index first.
### Arguments
@@ -32,4 +37,6 @@ Prints out a short help for the command.
Delete the segments named `_8c` and `_83` from the index located at `X:\category-data\`:
-<code>lucene index delete-segments X:\category-data _8c _83</code>
+```console
+lucene index delete-segments X:\category-data _8c _83
+```
diff --git a/src/dotnet/tools/lucene-cli/docs/index/extract-cfs.md b/src/dotnet/tools/lucene-cli/docs/index/extract-cfs.md
index 96c40e8..5d2f1c4 100644
--- a/src/dotnet/tools/lucene-cli/docs/index/extract-cfs.md
+++ b/src/dotnet/tools/lucene-cli/docs/index/extract-cfs.md
@@ -6,7 +6,9 @@
### Synopsis
-<code>lucene index extract-cfs \<CFS_FILE_NAME> [-dir|--directory-type] [?|-h|--help]</code>
+```console
+lucene index extract-cfs <CFS_FILE_NAME> [-dir|--directory-type] [?|-h|--help]
+```
### Description
@@ -34,9 +36,13 @@ The FSDirectory implementation to use. If ommitted, it defaults to the optimal F
Extract the files from the compound file at `X:\lucene-index\_81.cfs` to the current working directory:
-<code>lucene index extract-cfs X:\lucene-index\_81.cfs</code>
+```console
+lucene index extract-cfs X:\lucene-index\_81.cfs
+```
Extract the files from the compound file at `X:\lucene-index\_64.cfs` to the current working directory using the `SimpleFSDirectory` implementation:
-<code>lucene index extract-cfs X:\lucene-index\_64.cfs --directory-type SimpleFSDirectory</code>
+```console
+lucene index extract-cfs X:\lucene-index\_64.cfs --directory-type SimpleFSDirectory
+```
diff --git a/src/dotnet/tools/lucene-cli/docs/index/fix.md b/src/dotnet/tools/lucene-cli/docs/index/fix.md
index e352b8c..63ca2c8 100644
--- a/src/dotnet/tools/lucene-cli/docs/index/fix.md
+++ b/src/dotnet/tools/lucene-cli/docs/index/fix.md
@@ -6,13 +6,16 @@
### Synopsis
-<code>lucene index fix [\<INDEX_DIRECTORY>] [-v|--verbose] [-c|--cross-check-term-vectors] [-dir|--directory-type] [--dry-run] [?|-h|--help]</code>
+```console
+lucene index fix [<INDEX_DIRECTORY>] [-v|--verbose] [-c|--cross-check-term-vectors] [-dir|--directory-type] [--dry-run] [?|-h|--help]
+```
### Description
Basic tool to write a new segments file that removes reference to problematic segments. As this tool checks every byte in the index, on a large index it can take quite a long time to run.
-> **WARNING:** This command should only be used on an emergency basis as it will cause documents (perhaps many) to be permanently removed from the index. Always make a backup copy of your index before running this! Do not run this tool on an index that is actively being written to. You have been warned!
+> [!WARNING]
+> This command should only be used on an emergency basis as it will cause documents (perhaps many) to be permanently removed from the index. Always make a backup copy of your index before running this! Do not run this tool on an index that is actively being written to. You have been warned!
### Arguments
@@ -51,4 +54,6 @@ Check what a fix operation would do if run on the index located at `X:\product-i
Fix the index located at `X:\product-index` and cross check term vectors:
-<code>lucene index fix X:\product-index -c</code>
+```console
+lucene index fix X:\product-index -c
+```
diff --git a/src/dotnet/tools/lucene-cli/docs/index/index.md b/src/dotnet/tools/lucene-cli/docs/index/index.md
index 43f323e..bfaf7ba 100644
--- a/src/dotnet/tools/lucene-cli/docs/index/index.md
+++ b/src/dotnet/tools/lucene-cli/docs/index/index.md
@@ -4,7 +4,8 @@
Utilities to manage specialized analyzers.
-> **WARNING:** Many of these operations change an index in ways that cannot be reversed. Always make a backup of your index before running these commands.
+> [!WARNING]
+> Many of these operations change an index in ways that cannot be reversed. Always make a backup of your index before running these commands.
## Commands
diff --git a/src/dotnet/tools/lucene-cli/docs/index/list-cfs.md b/src/dotnet/tools/lucene-cli/docs/index/list-cfs.md
index 55d92a4..5bbddde 100644
--- a/src/dotnet/tools/lucene-cli/docs/index/list-cfs.md
+++ b/src/dotnet/tools/lucene-cli/docs/index/list-cfs.md
@@ -6,7 +6,9 @@
### Synopsis
-<code>lucene index list-cfs \<CFS_FILE_NAME> [-dir|--directory-type] [?|-h|--help]</code>
+```console
+lucene index list-cfs <CFS_FILE_NAME> [-dir|--directory-type] [?|-h|--help]
+```
### Description
@@ -32,5 +34,7 @@ The `FSDirectory` implementation to use. If omitted, defaults to the optimal `FS
Lists the files within the `X:\categories\_53.cfs` compound file using the `NIOFSDirectory` directory implementation:
-<code>lucene index list-cfs X:\categories\_53.cfs -dir NIOFSDirectory</code>
+```console
+lucene index list-cfs X:\categories\_53.cfs -dir NIOFSDirectory
+```
diff --git a/src/dotnet/tools/lucene-cli/docs/index/list-high-freq-terms.md b/src/dotnet/tools/lucene-cli/docs/index/list-high-freq-terms.md
index 4e69d2c..424d8d5 100644
--- a/src/dotnet/tools/lucene-cli/docs/index/list-high-freq-terms.md
+++ b/src/dotnet/tools/lucene-cli/docs/index/list-high-freq-terms.md
@@ -6,7 +6,9 @@
### Synopsis
-<code>lucene index list-high-freq-terms [\<INDEX_DIRECTORY>] [-t|--total-term-frequency] [-n|--number-of-terms] [-f|--field] [?|-h|--help]</code>
+```console
+lucene index list-high-freq-terms [<INDEX_DIRECTORY>] [-t|--total-term-frequency] [-n|--number-of-terms] [-f|--field] [?|-h|--help]
+```
### Description
@@ -41,9 +43,12 @@ The field to consider. If omitted, considers all fields.
List the high frequency terms in the index located at `F:\product-index\` on the `description` field, reporting both document frequency and term frequency:
-<code>lucene index list-high-freq-terms F:\product-index --total-term-frequency --field description</code>
-
+```console
+lucene index list-high-freq-terms F:\product-index --total-term-frequency --field description
+```
List the high frequency terms in the index located at `C:\lucene-index\` on the `name` field, tracking 30 terms:
-<code>lucene index list-high-freq-terms C:\lucene-index --f name -n 30</code>
+```console
+lucene index list-high-freq-terms C:\lucene-index --f name -n 30
+```
diff --git a/src/dotnet/tools/lucene-cli/docs/index/list-segments.md b/src/dotnet/tools/lucene-cli/docs/index/list-segments.md
index a1278f3..194b294 100644
--- a/src/dotnet/tools/lucene-cli/docs/index/list-segments.md
+++ b/src/dotnet/tools/lucene-cli/docs/index/list-segments.md
@@ -6,7 +6,9 @@
### Synopsis
-<code>lucene index list-segments [\<INDEX_DIRECTORY>] [?|-h|--help]</code>
+```console
+lucene index list-segments [\<INDEX_DIRECTORY>] [?|-h|--help]
+```
### Description
@@ -28,5 +30,7 @@ Prints out a short help for the command.
List the segments in the index located at `X:\lucene-index\`:
-<code>lucene index list-segments X:\lucene-index</code>
+```console
+lucene index list-segments X:\lucene-index
+```
diff --git a/src/dotnet/tools/lucene-cli/docs/index/list-taxonomy-stats.md b/src/dotnet/tools/lucene-cli/docs/index/list-taxonomy-stats.md
index 0916783..8e3eabf 100644
--- a/src/dotnet/tools/lucene-cli/docs/index/list-taxonomy-stats.md
+++ b/src/dotnet/tools/lucene-cli/docs/index/list-taxonomy-stats.md
@@ -6,7 +6,9 @@
### Synopsis
-<code>lucene index list-taxonomy-stats [\<INDEX_DIRECTORY>] [-tree|--show-tree] [?|-h|--help]</code>
+```console
+lucene index list-taxonomy-stats [<INDEX_DIRECTORY>] [-tree|--show-tree] [?|-h|--help]
+```
### Description
@@ -18,7 +20,8 @@ Prints how many ords are under each dimension.
The directory of the index. If omitted, it defaults to the current working directory.
-> **NOTE:** This directory must be a facet taxonomy directory for the command to succeed.
+> [!NOTE]
+> This directory must be a facet taxonomy directory for the command to succeed.
### Options
@@ -34,5 +37,7 @@ Recursively lists all descendant nodes.
List the taxonomy statistics from the index located at `X:\category-taxonomy-index\`, viewing all descendant nodes:
-<code>lucene index list-taxonomy-stats X:\category-taxonomy-index -tree</code>
+```console
+lucene index list-taxonomy-stats X:\category-taxonomy-index -tree
+```
diff --git a/src/dotnet/tools/lucene-cli/docs/index/list-term-info.md b/src/dotnet/tools/lucene-cli/docs/index/list-term-info.md
index 25a0c7b..3c077c1 100644
--- a/src/dotnet/tools/lucene-cli/docs/index/list-term-info.md
+++ b/src/dotnet/tools/lucene-cli/docs/index/list-term-info.md
@@ -6,7 +6,9 @@
### Synopsis
-<code>lucene index list-term-info \<INDEX_DIRECTORY> \<FIELD> \<TERM> [?|-h|--help]</code>
+```console
+lucene index list-term-info <INDEX_DIRECTORY> <FIELD> <TERM> [?|-h|--help]
+```
### Description
@@ -36,5 +38,7 @@ Prints out a short help for the command.
List the term information from the index located at `C:\project-index\`:
-<code>lucene index list-term-info C:\project-index</code>
+```console
+lucene index list-term-info C:\project-index
+```
diff --git a/src/dotnet/tools/lucene-cli/docs/index/merge.md b/src/dotnet/tools/lucene-cli/docs/index/merge.md
index 0ce1ca4..b492d8f 100644
--- a/src/dotnet/tools/lucene-cli/docs/index/merge.md
+++ b/src/dotnet/tools/lucene-cli/docs/index/merge.md
@@ -6,7 +6,9 @@
### Synopsis
-<code>lucene index merge \<OUTPUT_DIRECTORY> \<INPUT_DIRECTORY> \<INPUT_DIRECTORY_2>[ \<INPUT_DIRECTORY_N>...] [?|-h|--help]</code>
+```console
+lucene index merge <OUTPUT_DIRECTORY> <INPUT_DIRECTORY> <INPUT_DIRECTORY_2>[ <INPUT_DIRECTORY_N>...] [?|-h|--help]
+```
### Description
@@ -32,5 +34,7 @@ Prints out a short help for the command.
Merge the indexes `C:\product-index1` and `C:\product-index2` into an index located at `X:\merged-index`:
-<code>lucene index merge X:\merged-index C:\product-index1 C:\product-index2</code>
+```console
+lucene index merge X:\merged-index C:\product-index1 C:\product-index2
+```
diff --git a/src/dotnet/tools/lucene-cli/docs/index/split.md b/src/dotnet/tools/lucene-cli/docs/index/split.md
index 68b3a46..e690c17 100644
--- a/src/dotnet/tools/lucene-cli/docs/index/split.md
+++ b/src/dotnet/tools/lucene-cli/docs/index/split.md
@@ -6,7 +6,9 @@
### Synopsis
-<code>lucene index split \<OUTPUT_DIRECTORY> \<INPUT_DIRECTORY>[ \<INPUT_DIRECTORY_2>...] [-n|--number-of-parts] [-s|--sequential] [?|-h|--help]</code>
+```console
+lucene index split <OUTPUT_DIRECTORY> <INPUT_DIRECTORY>[ <INPUT_DIRECTORY_2>...] [-n|--number-of-parts] [-s|--sequential] [?|-h|--help]
+```
### Description
@@ -16,7 +18,8 @@ Deletes are only applied to a buffered list of deleted documents and don't affec
The disadvantage of this tool is that source index needs to be read as many times as there are parts to be created. The multiple passes may be slow.
-> **NOTE:** This tool is unaware of documents added automatically via `IndexWriter.AddDocuments(IEnumerable<IEnumerable<IIndexableField>>, Analyzer)` or `IndexWriter.UpdateDocuments(Term, IEnumerable<IEnumerable<IIndexableField>>, Analyzer)`, which means it can easily break up such document groups.
+> [!NOTE]
+> This tool is unaware of documents added automatically via `IndexWriter.AddDocuments(IEnumerable<IEnumerable<IIndexableField>>, Analyzer)` or `IndexWriter.UpdateDocuments(Term, IEnumerable<IEnumerable<IIndexableField>>, Analyzer)`, which means it can easily break up such document groups.
### Arguments
@@ -46,9 +49,13 @@ Sequential doc-id range split (default is round-robin).
Split the index located at `X:\old-index\` sequentially, placing the resulting 2 indices into the `X:\new-index\` directory:
-<code>lucene index split X:\new-index X:\old-index --sequential</code>
+```console
+lucene index split X:\new-index X:\old-index --sequential
+```
Split the index located at `T:\in\` into 4 parts and place them into the `T:\out\` directory:
-<code>lucene index split T:\out T:\in -n 4</code>
+```console
+lucene index split T:\out T:\in -n 4
+```
diff --git a/src/dotnet/tools/lucene-cli/docs/index/upgrade.md b/src/dotnet/tools/lucene-cli/docs/index/upgrade.md
index 1e9d16a..cc3fee8 100644
--- a/src/dotnet/tools/lucene-cli/docs/index/upgrade.md
+++ b/src/dotnet/tools/lucene-cli/docs/index/upgrade.md
@@ -6,7 +6,9 @@
### Synopsis
-<code>lucene index upgrade [\<INDEX_DIRECTORY>] [-d|--delete-prior-commits] [-v|--verbose] [-dir|--directory-type] [?|-h|--help]</code>
+```console
+lucene index upgrade [<INDEX_DIRECTORY>] [-d|--delete-prior-commits] [-v|--verbose] [-dir|--directory-type] [?|-h|--help]
+```
### Description
@@ -14,7 +16,8 @@ This tool keeps only the last commit in an index; for this reason, if the incomi
Specify an FSDirectory implementation through the --directory-type option to force its use. If not qualified by an AssemblyName, the Lucene.Net.dll assembly will be used.
-> **WARNING:** This tool may reorder document IDs! Be sure to make a backup of your index before you use this. Also, ensure you are using the correct version of this utility to match your application's version of Lucene.Net. This operation cannot be reversed.
+> [!WARNING]
+> This tool may reorder document IDs! Be sure to make a backup of your index before you use this. Also, ensure you are using the correct version of this utility to match your application's version of Lucene.NET. This operation cannot be reversed.
### Arguments
@@ -44,9 +47,13 @@ The `FSDirectory` implementation to use. Defaults to the optional `FSDirectory`
Upgrade the index format of the index located at `X:\lucene-index\` to the same version as this tool, using the `SimpleFSDirectory` implementation:
-<code>lucene index upgrade X:\lucene-index -dir SimpleFSDirectory</code>
+```console
+lucene index upgrade X:\lucene-index -dir SimpleFSDirectory
+```
Upgrade the index located at `C:\indexes\category-index\` verbosely, deleting all but the last commit:
-<code>lucene index upgrade C:\indexes\category-index --verbose --delete-prior-commits</code>
+```console
+lucene index upgrade C:\indexes\category-index --verbose --delete-prior-commits
+```
diff --git a/src/dotnet/tools/lucene-cli/docs/lock/stress-test.md b/src/dotnet/tools/lucene-cli/docs/lock/stress-test.md
index 73ee099..fafd708 100644
--- a/src/dotnet/tools/lucene-cli/docs/lock/stress-test.md
+++ b/src/dotnet/tools/lucene-cli/docs/lock/stress-test.md
@@ -6,7 +6,9 @@
### Synopsis
-<code>lucene lock stress-test \<ID> \<VERIFIER_HOST> \<VERIFIER_PORT> \<LOCK_FACTORY_TYPE> \<LOCK_DIRECTORY> \<SLEEP_TIME_MS> \<TRIES> [?|-h|--help]</code>
+```console
+lucene lock stress-test <ID> <VERIFIER_HOST> <VERIFIER_PORT> <LOCK_FACTORY_TYPE> <LOCK_DIRECTORY> <SLEEP_TIME_MS> <TRIES> [?|-h|--help]
+```
### Description
@@ -52,4 +54,6 @@ Prints out a short help for the command.
Run the client (stress test), connecting to the server on IP address `127.0.0.4` and port `54464` using the ID 3, the `NativeFSLockFactory`, specifying the lock directory as `F:\temp`, sleep for 50 milliseconds, and try to obtain a lock up to 10 times:
-<code>lucene lock stress-test 3 127.0.0.4 54464 NativeFSLockFactory F:\temp 50 10</code>
+```console
+lucene lock stress-test 3 127.0.0.4 54464 NativeFSLockFactory F:\temp 50 10
+```
diff --git a/src/dotnet/tools/lucene-cli/docs/lock/verify-server.md b/src/dotnet/tools/lucene-cli/docs/lock/verify-server.md
index d3f1f2b..e908844 100644
--- a/src/dotnet/tools/lucene-cli/docs/lock/verify-server.md
+++ b/src/dotnet/tools/lucene-cli/docs/lock/verify-server.md
@@ -6,7 +6,9 @@
### Synopsis
-<code>lucene lock verify-server \<IP_HOSTNAME> \<MAX_CLIENTS> [?|-h|--help]</code>
+```console
+lucene lock verify-server <IP_HOSTNAME> <MAX_CLIENTS> [?|-h|--help]
+```
### Description
@@ -32,4 +34,6 @@ Prints out a short help for the command.
Run the server on IP `127.0.0.4` with a 10 connected clients:
-<code>lucene lock verify-server 127.0.0.4 10</code>
+```console
+lucene lock verify-server 127.0.0.4 10
+```