Skip to main content

Client Command (hcp-ls)

The hcp-ls command gets the file list on the remote servers (server or hcpd server).

Basic Format#

The basic format is as follows.

Usage: hcp-ls [OPTION]... [USER@]HOST[:PORT][:FILE] [:FILE]...   or: hcp-ls [OPTION]... --host=HOST [--port=PORT] [--user=USER] [FILE]...

Option List#

The options for the hcp-ls commands are below.

File List Acquisition

DescriptionShort NameOption Name
Set the flag to query command namesqquery-cmdname
Set the command optionocmd-options
Set the remote hosthost
Set the remote portport

Selectable Communication Method Function

DescriptionShort NameOption Name
The HpFP protocolhpfp
The WebSocket protocol(SSL/TLS)wss
The port-separation UDP(HpFP) protocol(deprecated)udp
The WebSocket protocol (plaintext communications)ws
Directly connect to the Proxy server when the WebSocket protocolws-proxy-direct
Set the Proxy server when the WebSocket protocolws-proxy

Congestion Control

DescriptionShort NameOption Name
Congestion control modes in the HpFP protocolhpfp-cong

Data Flow Control, Message Data Size Control

DescriptionShort NameOption Name
MSS(Maximum Segment Size) in the HpFP protocolhpfp-mss

Data Flow Control, Data Buffer Setting

DescriptionShort NameOption Name
Set the sending buffer size for the HpFP protocolhpfp-sndbuf
Set the receiving buffer size for the HpFP protocolhpfp-rcvbuf

Authentication

DescriptionShort NameOption Name
Server certificate checking is disabled in WebSocket protocol communicationswss-no-check-certificate
Specify a username first and file list acquisitionuser
Specify a password first and file list acquisitionpassword

Various Monitorings

DescriptionShort NameOption Name
Investigation mode starts (deprecated)investigation

Log Management

DescriptionShort NameOption Name
Specify an application log output destinationlog-file
Specify various statistics log output destinationsstat-log-file
Specify an execution record output destinationhcp-out
Start in the multiple-run modemulti-run

Software Information Update

DescriptionShort NameOption Name
Check the application versionVversion
Check the configuration and input parametersconfig-test
Display the command helphhelp

System Operating Environment Settings

DescriptionShort NameOption Name
Setting form a path of the configuration fileconfig-file
Make configuration from command lineconfig-option
Setting by a relative path from the current directoryinclude-conf-from-cwd
Server compatibility disabledno-earlier-serv-compat

Please refer to the hcpd command section on the following option.

--investigation

Please refer to the hcp command section on the following option.

--hpfp, --wss, --user, --password, --config-file, --config-option, --log-file, --stat-log-file,--udp, --ws, --wss-no-check-certificate, --ws-proxy-direct, --ws-proxy, --hpfp-cong, --hpfp-mss, --hpfp-sndbuf, --hpfp-rcvbuf, --multi-run, --include-conf-from-cwd, --no-earlier-serv-compat

File List Acquisition#

q, query-cmdname#

=========================================================================Supported OS : Linux / WindowsFormat : -q | --query-cmdname=========================================================================

Command names on the command list operated on servers are queried. Either of the following commands is shown.

  • ls (Linux)
  • dir (Windows)
--Example:[user@localhost ~]$ hcp-ls -q ...--

o, cmd-options#

=========================================================================Supported OS : Linux / WindowsFormat : -o <options> | --cmd-options=<options>-------------------------------------------------------------------------optionsDefault : noneRange of Values : parameter option for the ls or dir command.=========================================================================

The command options are set. When they include the blank or โ€œ-โ€, it should be quote.

--Example:[user@localhost ~]$ hcp-ls -o "-al" ...--

host#

=========================================================================Supported OS : Linux / WindowsFormat : --host=<remote-host>-------------------------------------------------------------------------remote-hostDefault : noneRange of Values : IP address or host name=========================================================================

The destination remote host is specified, which is applied to the path for the listed target. With this parameter, the host name can be abbreviated.

--Example:[user@localhost ~]$ hcp-ls --host=192.168.100.100 ...--

port#

=========================================================================Supported OS : Linux / WindowsFormat : --port=<remote-port>-------------------------------------------------------------------------remote-portDefault : noneRange of Values : port number=========================================================================

The service port number for the destination remote host is specified, which is applied to the path for the listed target.

--Example:[user@localhost ~]$ hcp-ls --port=1874 ...--

Log Management#

hcp-out#

=========================================================================Supported OS : Linux / WindowsFormat : --hcp-out=<output-path>-------------------------------------------------------------------------output-pathDefault : noneRange of Values : path string of file system=========================================================================

The file to output the execution record of file list acquirement is set. The execution result of the list is always output as standard output.

--Example:FILE 127.0.0.1:11111:/home/user/Desktop/hcp_dst5--
--Example:[user@localhost ~]$ hcp-ls --hcp-out=- ...--

Software Information Uupdate#

V, version#

=========================================================================Supported OS : Linux / WindowsFormat : -V | --version=========================================================================

The hcp-ls command version is shown.

--Example:[user@localhost ~]$ hcp-ls -Vhcp-ls client (hcp-ls) 1.3.4_3 / Linux (HpFP2 2.0.0.91_21 WSAPI 0.0.1.30 WS 4.2.0-1)--

config-test#

=========================================================================Supported OS : Linux / WindowsFormat : --config-test=========================================================================

Display the input parameters for the hcp-ls command and the configuration information.

--Example:[user@localhost ~]$ hcp-ls --config-test...
Number of Logical Processors  : 2Number of Physical Processors : 2
Command parameters query-cmdname      : disable cmd-options        : - host     : disable port     : disable user           : disable password       : disable version        : disable help           : disable

Configuration parameters PubkeyAuthentication             : yes WinLogonUserAuthentication       : yes PAMAuthentication                : yes LocalPasswordAuthentication      : yes CompressLevel                    : -1 StrictHostKeyChecking            : ask PrivateKeyFile                   : - [~/.hcp/id_rsa] TransportTimeout                 : 180 AcceptableCryptMethod            : AES256/GCM AES256/CTR/VMAC AES256/CBC AES128/CBC [Intel:AES-NI=yes] AcceptableDigestMethod           : XXH3 MM128 SHA256 SHA160
Please type '--config-test --config-test ...' for more details.--

h, help#

=========================================================================Supported OS : Linux / WindowsFormat : -h | --help=========================================================================

The hcp-ls command help line is shown.

--Example:[user@localhost ~]$ hcp-ls -h--