m4/lls/client.suite.m4

   1 m4_define(PROGRAM, para_client)
   2 m4_define(DEFAULT_HISTORY_FILE, ~/.paraslash/client.history)
   3 m4_define(DEFAULT_CONFIG_FILE,~/.paraslash/client.conf)
   4 [suite client]
   5 version-string = GIT_VERSION()
   6 [supercommand para_client]
   7         purpose = Communicate with para_server through the paraslash control port
   8         non-opts-name = [command [options]]
   9         [description]
  10                 para_client is the program used to connect to a running instance of
  11                 para_server. If a command is provided, this command is sent to the
  12                 server and any output received from the server is echoed to stdout. If
  13                 no command is given, para_client enters interactive mode.
  14         [/description]
  15         m4_include(common-option-section.m4)
  16         m4_include(help.m4)
  17         m4_include(detailed-help.m4)
  18         m4_include(version.m4)
  19         m4_include(loglevel.m4)
  20         m4_include(config-file.m4)
  21         m4_include(history-file.m4)
  22         m4_include(per-command-options-section.m4)
  23         [option hostname]
  24                 short_opt = i
  25                 summary = IP address or name of the host where para_server is running
  26                 typestr = host
  27                 arg_info = required_arg
  28                 arg_type = string
  29                 default_val = localhost
  30                 [help]
  31                         Both IPv4 and IPv6 addresses are supported.
  32                 [/help]
  33         [option user]
  34                 short_opt = u
  35                 summary = the paraslash username to authenticate as
  36                 arg_info = required_arg
  37                 arg_type = string
  38                 typestr = name
  39                 [help]
  40                         If this is not given, the current username is assumed.
  41                 [/help]
  42         [option server-port]
  43                 short_opt = p
  44                 summary = the port on the remote host to connect
  45                 arg_info = required_arg
  46                 arg_type = uint32
  47                 typestr = portnumber
  48                 default_val = 2990
  49                 [help]
  50                         If this is not given, the current username is assumed.
  51                 [/help]
  52         [option key-file]
  53                 short_opt = k
  54                 summary = path to private key
  55                 arg_info = required_arg
  56                 arg_type = string
  57                 typestr = filename
  58                 [help]
  59                         If not given, the following files are tried, in order:
  60                         $HOME/.paraslash/key.$LOGNAME, $HOME/.ssh/id_rsa. It is a fatal error
  61                         if the key file can not be opened, or is world-readable.
  62                 [/help]
  63         m4_include(complete.m4)