You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@lucene.apache.org by ge...@apache.org on 2020/01/13 11:35:04 UTC
[lucene-solr] branch master updated: SOLR-13934: Improve
SimplePostTool & bin/post docs (#1013)
This is an automated email from the ASF dual-hosted git repository.
gerlowskija pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/lucene-solr.git
The following commit(s) were added to refs/heads/master by this push:
new e5cff17 SOLR-13934: Improve SimplePostTool & bin/post docs (#1013)
e5cff17 is described below
commit e5cff170b7f5458f84a8ad86715dacdb7a3a0aa1
Author: RompotiMiranda <43...@users.noreply.github.com>
AuthorDate: Mon Jan 13 11:34:47 2020 +0000
SOLR-13934: Improve SimplePostTool & bin/post docs (#1013)
Co-Authored-By: RompotiMiranda
---
solr/solr-ref-guide/src/post-tool.adoc | 25 +++++++++++++++----------
1 file changed, 15 insertions(+), 10 deletions(-)
diff --git a/solr/solr-ref-guide/src/post-tool.adoc b/solr/solr-ref-guide/src/post-tool.adoc
index 3d736b5..140c287 100644
--- a/solr/solr-ref-guide/src/post-tool.adoc
+++ b/solr/solr-ref-guide/src/post-tool.adoc
@@ -159,20 +159,25 @@ bin/post -u solr:SolrRocks -c gettingstarted a.pdf
== Post Tool Windows Support
-`bin/post` exists currently only as a Unix shell script, however it delegates its work to a cross-platform capable Java program. The <<SimplePostTool>> can be run directly in supported environments, including Windows.
+`bin/post` is a Unix shell script and as such cannot be used directly on Windows.
+However it delegates its work to a cross-platform capable Java program called "SimplePostTool" or `post.jar`, that can be used in Windows environments.
-== SimplePostTool
+The argument syntax differs significantly from `bin/post`, so your first step should be to print the SimplePostTool help text.
-The `bin/post` script currently delegates to a standalone Java program called `SimplePostTool`.
+[source,plain]
+----
+$ java -jar example\exampledocs\post.jar -h
+----
-This tool, bundled into a executable JAR, can be run directly using `java -jar example/exampledocs/post.jar`. See the help output and take it from there to post files, recurse a website or file system folder, or send direct commands to a Solr server.
+This command prints information about all the arguments and System properties available to SimplePostTool users.
+There are also examples showing how to post files, crawl a website or file system folder, and send update commands (deletes, etc.) directly to Solr.
+
+Most usage involves passing both Java System properties and program arguments on the command line. Consider the example below:
[source,plain]
----
-$ java -jar example/exampledocs/post.jar -h
-SimplePostTool version 5.0.0
-Usage: java [SystemProperties] -jar post.jar [-h|-] [<file|folder|url|arg> [<file|folder|url|arg>...]]
-.
-.
-.
+$ java -jar -Dc=gettingstarted -Dauto example\exampledocs\post.jar example\exampledocs\*
----
+
+This indexes the contents of the `exampledocs` directory into a collection called `gettingstarted`.
+The `-Dauto` System property governs whether or not Solr sends the document type to Solr during extraction.