doc/plane.md

   1 <!--
   2 SPDX-FileCopyrightText: 2022 Frank Doepper
   3
   4 SPDX-License-Identifier: FSFAP
   5 -->
   6
   7 ---
   8 title: plane
   9 section: 1
  10 header: haskell-amqp-utils
  11 footer: haskell-amqp-utils 0.6.5.0
  12 date: 2022-11-11
  13 ---
  14
  15 # NAME
  16 plane - an AMQP RPC client.
  17
  18 # SYNOPSIS
  19 **plane** [*options*]
  20
  21 # DESCRIPTION
  22
  23 # OPTIONS
  24       -r ROUTINGKEY, -Q ROUTINGKEY  --routingkey=ROUTINGKEY, --qname=ROUTINGKEY  AMQP routing key
  25       -f INPUTFILE                  --inputfile=INPUTFILE                        Message input file (default: <stdin>)
  26       -O OUTPUTFILE                 --outputfile=OUTPUTFILE                      Message output file (default: -)
  27       -t SECONDS                    --rpc_timeout=SECONDS                        How long to wait for reply (default: 5.0)
  28                                     --corrid=CORRID                              Message CorrelationID
  29                                     --exp=EXP                                    Message Expiration
  30       -h HEADER=VALUE               --header=HEADER=VALUE                        Message Headers
  31       -l INT                        --charlimit=INT                              limit number of shown body chars (default: unlimited)
  32       -x EXCHANGE                   --exchange=EXCHANGE                          AMQP Exchange (default: "")
  33       -o SERVER                     --server=SERVER                              AMQP Server (default: localhost)
  34       -y VHOST                      --vhost=VHOST                                AMQP Virtual Host (default: /)
  35       -p PORT                       --port=PORT                                  Server Port Number (default: 5672)
  36       -T                            --tls                                        Toggle TLS (default: False)
  37       -c CERTFILE                   --cert=CERTFILE                              TLS Client Certificate File
  38       -k KEYFILE                    --key=KEYFILE                                TLS Client Private Key File
  39       -U USERNAME                   --user=USERNAME                              Username for Auth
  40       -P PASSWORD                   --pass=PASSWORD                              Password for Auth
  41       -s INT                        --heartbeats=INT                             heartbeat interval (0=disable, default: set by server)
  42       -n NAME                       --name=NAME                                  connection name, will be shown in RabbitMQ web interface
  43       -w SECONDS                    --connect_timeout=SECONDS                    timeout for establishing initial connection (default: 600)
  44 <!--
  45 SPDX-FileCopyrightText: 2022 Frank Doepper
  46
  47 SPDX-License-Identifier: FSFAP
  48 -->
  49
  50 # EXAMPLES
  51
  52 send "ls" to a remote worker and get the result:
  53
  54     echo ls | plane -o amqp.example.com -T -k amqp.pem -c amqp.pem -y myexchange -Q rpctest
  55