janhoy commented on code in PR #4271: URL: https://github.com/apache/solr/pull/4271#discussion_r3247438921
########## solr/solr-ref-guide/modules/deployment-guide/pages/cli/solr-start.adoc: ########## @@ -0,0 +1,125 @@ +// Licensed to the Apache Software Foundation (ASF) under one +// or more contributor license agreements. See the NOTICE file +// distributed with this work for additional information +// regarding copyright ownership. The ASF licenses this file +// to you under the Apache License, Version 2.0 (the +// "License"); you may not use this file except in compliance +// with the License. You may obtain a copy of the License at +// +// http://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, +// software distributed under the License is distributed on an +// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +// KIND, either express or implied. See the License for the +// specific language governing permissions and limitations +// under the License. +// DO NOT EDIT -- this page is auto-generated from picocli annotations. +// To update: modify the @Command/@Option annotations in the Java source, then run: +// ./gradlew :solr:solr-ref-guide:generateCliDocs + += bin/solr start +:page-toclevels: 2 + +// tag::picocli-generated-man-section-name[] +== Name + +bin/solr start - Starts Solr in standalone or SolrCloud mode. + +// end::picocli-generated-man-section-name[] + +// tag::picocli-generated-man-section-synopsis[] +== Synopsis + +*bin/solr start* [*-fhqVy*] [*--force*] [*--user-managed*] [*--verbose*] + [*--data-home*=_<dataHome>_] [*-e*=_<example>_] + [*--example-dir*=_<exampleDir>_] [*--host*=_<host>_] [*-j*=_<jettyParams>_] + [*--jvm-opts*=_<jvmOpts>_] [*-m*=_<memory>_] [*-p*=_<port>_] + [*--prompt-inputs*=_<values>_] [*--server-dir*=_<serverDir>_] + [*--solr-home*=_<solrHome>_] [*-z*=_<zkHost>_] + +// end::picocli-generated-man-section-synopsis[] + +// tag::picocli-generated-man-section-description[] +== Description + +Starts Solr in standalone or SolrCloud mode. + +// end::picocli-generated-man-section-description[] + +// tag::picocli-generated-man-section-options[] +== Options + +*--data-home*=_<dataHome>_:: + Set solr.data.home system property for index data storage; default is solr.solr.home + +*-e*, *--example*=_<example>_:: + Run an example: cloud, techproducts, schemaless, films + +*--example-dir*=_<exampleDir>_:: + Override the directory containing example configurations used when running examples with --example + +*-f*, *--foreground*:: + Start Solr in foreground; default is background with logs to solr-PORT-console.log + +*--force*:: + Override warning when attempting to start Solr as root user + +*-h*, *--help*:: + Show this help message and exit. + +*--host*=_<host>_:: + Specify the hostname for this Solr instance + +*-j*, *--jettyconfig*=_<jettyParams>_:: + Additional Jetty parameters, e.g., -j "--include-jetty-dir=/etc/jetty/custom/server/" + +*--jvm-opts*=_<jvmOpts>_:: + Additional JVM parameters, e.g., --jvm-opts "-verbose:gc" + +*-m*, *--memory*=_<memory>_:: + Set JVM heap size, e.g., -m 4g sets -Xms4g -Xmx4g; default is 512m + +*-p*, *--port*=_<port>_:: + Specify the Solr HTTP port; default is 8983. STOP_PORT=($SOLR_PORT-1000), RMI_PORT=($SOLR_PORT+10000) + +*--prompt-inputs*=_<values>_:: + Don't prompt for input; comma-delimited list of inputs to use when running examples that accept user input + +*-q*, *--quiet*:: + Set log level to WARN (quiet); default is INFO + +*--server-dir*=_<serverDir>_:: + Specify the Solr server directory; default is 'server' + +*--solr-home*=_<solrHome>_:: + Set solr.solr.home system property; default is 'server/solr'. Ignored in examples mode + +*--user-managed*:: + Start Solr in standalone mode. Default is SolrCloud (ZooKeeper) mode. + +*-V*, *--version*:: + Print version information and exit. + +*--verbose*:: + Set log level to DEBUG (verbose); default is INFO + +*-y*, *--no-prompt*:: + Don't prompt for input; accept all defaults when running examples + +*-z*, *--zk-host*=_<zkHost>_:: + Zookeeper connection string; default is to start an embedded ZooKeeper on PORT+10000 + +// end::picocli-generated-man-section-options[] + +// tag::picocli-generated-man-section-arguments[] +// end::picocli-generated-man-section-arguments[] + +// tag::picocli-generated-man-section-commands[] +// end::picocli-generated-man-section-commands[] + +// tag::picocli-generated-man-section-exit-status[] +// end::picocli-generated-man-section-exit-status[] Review Comment: I added example and exit-code documentation to the `status` tool. Here is how it looks: <img width="800" height="605" alt="Skjermbilde 2026-05-15 kl 12 08 25" src="https://github.com/user-attachments/assets/0fcff84e-7154-4e14-abea-ae03b98b3695"; /> -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected] --------------------------------------------------------------------- To unsubscribe, e-mail: [email protected] For additional commands, e-mail: [email protected]
