Skip to content

Latest commit

 

History

History
63 lines (41 loc) · 2.05 KB

mbmd_completion_zsh.md

File metadata and controls

63 lines (41 loc) · 2.05 KB

mbmd completion zsh

Generate the autocompletion script for zsh

Synopsis

Generate the autocompletion script for the zsh shell.

If shell completion is not already enabled in your environment you will need to enable it. You can execute the following once:

echo "autoload -U compinit; compinit" >> ~/.zshrc

To load completions in your current shell session:

source <(mbmd completion zsh)

To load completions for every new session, execute once:

Linux:

mbmd completion zsh > "${fpath[1]}/_mbmd"

macOS:

mbmd completion zsh > $(brew --prefix)/share/zsh/site-functions/_mbmd

You will need to start a new shell for this setup to take effect.

mbmd completion zsh [flags]

Options

      --no-descriptions   disable completion descriptions

Options inherited from parent commands

  -a, --adapter string     Default MODBUS adapter. This option can be used if all devices are attached to a single adapter.
                           Can be either an RTU device (/dev/ttyUSB0) or TCP socket (localhost:502).
                           The default adapter can be overridden per device
  -b, --baudrate int       Serial interface baud rate (default 9600)
      --comset string      Communication parameters for default adapter, either 8N1 or 8E1.
                           Only applicable if the default adapter is an RTU device (default "8N1")
  -c, --config string      Config file (default is $HOME/mbmd.yaml, ./mbmd.yaml, /etc/mbmd.yaml)
  -h, --help               Help for mbmd
      --raw                Log raw device data
      --rtu                Use RTU over TCP for default adapter.
                           Typically used with RS485 to Ethernet adapters that don't perform protocol conversion (e.g. USR-TCP232).
                           Only applicable if the default adapter is a TCP connection
      --timeout duration   Timeout for MODBUS communication (default 300ms)
  -v, --verbose            Verbose mode

SEE ALSO

  • mbmd completion - Generate the autocompletion script for the specified shell