Skip to content

Listen

Starts a distant manager listening for new actions to perform.

distant manager listen

Flags

  • --access <ACCESS>: type of access to apply to created unix socket or windows pipe.

    • owner: equates to 0o600 on Unix (read & write for owner).
    • group: equates to 0o660 on Unix (read & write for owner and group).
    • anyone: equates to 0o666 on Unix (read & write for owner, group, and other).

  • --daemon: runs the manager process as a daemon, meaning that it is detached from the parent process and will continue running even after the parent exits. On Unix systems this involves fork while on Windows this uses CreateProcess in a detached state.

  • --user: will listen on a user-local Unix domain socket (UDS) or local named Windows pipe. Normally, distant will attempt to create a UDS in a globally-accessible area or establish a global pipe.

distant manager listen --help 
Listen for incoming requests as a manager

Usage: distant manager listen [OPTIONS]

Options:
      --access <ACCESS>
          Type of access to apply to created unix socket or windows pipe

          Possible values:
          - owner:  Equates to `0o600` on Unix (read & write for owner)
          - group:  Equates to `0o660` on Unix (read & write for owner and group)
          - anyone: Equates to `0o666` on Unix (read & write for owner, group, and other)

      --log-level <LOG_LEVEL>
          Log level to use throughout the application

          [possible values: off, error, warn, info, debug, trace]

      --daemon
          If specified, will fork the process to run as a standalone daemon

      --log-file <LOG_FILE>
          Path to file to use for logging

      --config <CONFIG_PATH>
          Configuration file to load instead of the default paths

      --user
          If specified, will listen on a user-local unix socket or local windows named pipe

      --unix-socket <UNIX_SOCKET>
          Override the path to the Unix socket used by the manager (unix-only)

      --windows-pipe <WINDOWS_PIPE>
          Override the name of the local named Windows pipe used by the manager (windows-only)

  -h, --help
          Print help (see a summary with '-h')