@cryptotaxi247 / netdata-1 / commits / bbb546ec1

tidy up the installer script usage message (#12171)

Pete Cooper committed Feb 17, 2022 at 17:30 UTC bbb546ec1497ea9a018ba6fbf33b67e2c6a568a8
1 file changed +37 -31
netdata-installer.sh
+37 -31
@@ -207,7 +207,7 @@ banner_root_notify() {
207 Netdata will work, but a few data collection modules that
208 require root access will fail.
209
210 - If you installing netdata permanently on your system, run
210 + If you are installing netdata permanently on your system, run
211 the installer like this:
212
213 ${TPUT_YELLOW}${TPUT_BOLD}sudo $PROGRAM ${@}${TPUT_RESET}
@@ -223,50 +223,50 @@ usage() {
223 USAGE: ${PROGRAM} [options]
224 where options include:
225
226 - --install <path> Install netdata in <path>. Ex. --install /opt will put netdata in /opt/netdata
227 - --dont-start-it Do not (re)start netdata after installation
228 - --dont-wait Run installation in non-interactive mode
229 - --auto-update or -u Install netdata-updater in cron to update netdata automatically once per day
226 + --install <path> Install netdata in <path>. Ex. --install /opt will put netdata in /opt/netdata.
227 + --dont-start-it Do not (re)start netdata after installation.
228 + --dont-wait Run installation in non-interactive mode.
229 + --auto-update or -u Install netdata-updater in cron to automatically check for updates once per day.
230 --auto-update-type Override the auto-update scheduling mechanism detection, currently supported types
231 - are: systemd, interval, crontab
232 - --stable-channel Use packages from GitHub release pages instead of GCS (nightly updates).
231 + are: systemd, interval, crontab.
232 + --stable-channel Use packages from GitHub release pages instead of nightly updates.
233 This results in less frequent updates.
234 --nightly-channel Use most recent nightly updates instead of GitHub releases.
235 This results in more frequent updates.
236 --disable-go Disable installation of go.d.plugin.
237 - --disable-ebpf Disable eBPF Kernel plugin (Default: enabled)
237 + --disable-ebpf Disable eBPF Kernel plugin. Default: enabled.
238 --disable-cloud Disable all Netdata Cloud functionality.
239 --require-cloud Fail the install if it can't build Netdata Cloud support.
240 --enable-plugin-freeipmi Enable the FreeIPMI plugin. Default: enable it when libipmimonitoring is available.
241 - --disable-plugin-freeipmi
242 - --disable-https Explicitly disable TLS support
243 - --disable-dbengine Explicitly disable DB engine support
241 + --disable-plugin-freeipmi Explicitly disable the FreeIPMI plugin.
242 + --disable-https Explicitly disable TLS support.
243 + --disable-dbengine Explicitly disable DB engine support.
244 --enable-plugin-nfacct Enable nfacct plugin. Default: enable it when libmnl and libnetfilter_acct are available.
245 - --disable-plugin-nfacct
246 - --enable-plugin-xenstat Enable the xenstat plugin. Default: enable it when libxenstat and libyajl are available
247 - --disable-plugin-xenstat Disable the xenstat plugin.
248 - --enable-backend-kinesis Enable AWS Kinesis backend. Default: enable it when libaws_cpp_sdk_kinesis and libraries
249 - it depends on are available.
250 - --disable-backend-kinesis
245 + --disable-plugin-nfacct Explicitly disable the nfacct plugin.
246 + --enable-plugin-xenstat Enable the xenstat plugin. Default: enable it when libxenstat and libyajl are available.
247 + --disable-plugin-xenstat Explicitly disable the xenstat plugin.
248 + --enable-backend-kinesis Enable AWS Kinesis backend. Default: enable it when libaws_cpp_sdk_kinesis and its dependencies
249 + are available.
250 + --disable-backend-kinesis Explicitly disable AWS Kinesis backend.
251 --enable-backend-prometheus-remote-write Enable Prometheus remote write backend. Default: enable it when libprotobuf and
252 libsnappy are available.
253 - --disable-backend-prometheus-remote-write
253 + --disable-backend-prometheus-remote-write Explicitly disable Prometheus remote write backend.
254 --enable-backend-mongodb Enable MongoDB backend. Default: enable it when libmongoc is available.
255 - --disable-backend-mongodb
255 + --disable-backend-mongodb Explicitly disable MongoDB backend.
256 --enable-exporting-pubsub Enable Google Cloud PubSub exporting connector. Default: enable it when
257 libgoogle_cloud_cpp_pubsub_protos and its dependencies are available.
258 - --disable-exporting-pubsub
259 - --enable-lto Enable Link-Time-Optimization. Default: disabled
260 - --disable-lto
261 - --enable-ml Enable anomaly detection with machine learning. (Default: autodetect)
262 - --disable-ml
263 - --disable-x86-sse Disable SSE instructions. By default SSE optimizations are enabled.
264 - --use-system-lws Use a system copy of libwebsockets instead of bundling our own (default is to use the bundled copy).
265 - --use-system-protobuf Use a system copy of libprotobuf instead of bundling our own (default is to use the bundled copy).
266 - --zlib-is-really-here or
267 - --libs-are-really-here If you get errors about missing zlib or libuuid but you know it is available, you might
258 + --disable-exporting-pubsub Explicitly disable Google Cloud PubSub exporting connector.
259 + --enable-lto Enable link-time optimization. Default: disabled.
260 + --disable-lto Explicitly disable link-time optimization.
261 + --enable-ml Enable anomaly detection with machine learning. Default: autodetect.
262 + --disable-ml Explicitly disable anomaly detection with machine learning.
263 + --disable-x86-sse Disable SSE instructions & optimizations. Default: enabled.
264 + --use-system-lws Use a system copy of libwebsockets instead of bundled copy. Default: bundled.
265 + --use-system-protobuf Use a system copy of libprotobuf instead of bundled copy. Default: bundled.
266 + --zlib-is-really-here
267 + --libs-are-really-here If you see errors about missing zlib or libuuid but you know it is available, you might
268 have a broken pkg-config. Use this option to proceed without checking pkg-config.
269 - --disable-telemetry Use this flag to opt-out from our anonymous telemetry program. (DISABLE_TELEMETRY=1)
269 + --disable-telemetry Opt-out from our anonymous telemetry program. (DISABLE_TELEMETRY=1)
270 --skip-available-ram-check Skip checking the amount of RAM the system has and pretend it has enough to build safely.
271
272 Netdata will by default be compiled with gcc optimization -O2
@@ -284,7 +284,13 @@ or use the following if both LDFLAGS and CFLAGS need to be overridden:
284
285 For the installer to complete successfully, you will need these packages installed:
286
287 - gcc make autoconf automake pkg-config zlib1g-dev (or zlib-devel) uuid-dev (or libuuid-devel)
287 + gcc
288 + make
289 + autoconf
290 + automake
291 + pkg-config
292 + zlib1g-dev (or zlib-devel)
293 + uuid-dev (or libuuid-devel)
294
295 For the plugins, you will at least need:
296