Skip to main content

Client Command (hln)

The hln commands creates links for the files and directories on the remote server and hcpd server.These commands are not supported on Windows OS.

Basic Format#

The basic format is as follows.

Usage: hln [OPTION]... [USER@]HOST[:PORT]:TARGET :LINK_NAME   or: hln [OPTION]... [USER@]HOST[:PORT]:TARGET [:TARGET]... :DIRECTORY   or: hln [OPTION]... --host=HOST [--port=PORT] [--user=USER] TARGET LINK_NAME   or: hln [OPTION]... --host=HOST [--port=PORT] [--user=USER] TARGET... DIRECTORY

Option List#

The options for the hln commands are below.

Link Creating

DescriptionShort NameOption Name
Force overwriting in the destinationfforce
Interactive overwriting in the destinationiinteractive
Disable the dereference of the directory for the symbolic linkNno-dereference
Create symboloc linkssymbolic
Use the target path as a logic name (symbolic link is resolved)Llogical
Use the target path as a logic name (symbolic link isn’t resolved)Pphysical
expand the target's relative path to an absolute pathsymlink-target-expand-relative
accept the target expansion (when server is an older versin)symlink-target-accept-expand-relative
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 link creatinguser
Specify a password first and link creatingpassword

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

Link Creating#

f, force#

=========================================================================Supported OS : Linux / WindowsFormat : -f | --force=========================================================================

When the same link exists in the destination, it is supposed to be overwritten without confirmation.

--Example:[user@localhost ~]$ hln -f ...--

i, interactive#

=========================================================================Supported OS : Linux / WindowsFormat : -i | --interactive=========================================================================

When the same link name exists in the destination, whether the link which has already existed in the destination is deleted is confirmed before overwriting.

--Example:[user@localhost ~]$ hln -i ...--

N, no-dereference#

=========================================================================Supported OS : Linux / WindowsFormat : -N | --no-dereference=========================================================================

With this option, in the case that the path specified as the link is a symbolic link to a directory, this link is processed without dereferencing. On the other hand, when this option is not specified, the link is created with the target file name in the directory. This option changes this behavior.

--Example:[user@localhost ~]$ hln -N ...--

s, symbolic#

=========================================================================Supported OS : Linux / WindowsFormat : -s | --symbolic=========================================================================

Symbolic links will be created instead of hard links.

--Example:[user@localhost ~]$ hln -s ...--

L, logical#

=========================================================================Supported OS : Linux / WindowsFormat : -L | --logical=========================================================================

In the case of the hard link, the path for the target is regarded as the logical name. When the path is a symbolic link, resolved path is used.

--Example:[user@localhost ~]$ hln -L ...--

P, physical#

=========================================================================Supported OS : Linux / WindowsFormat : -P | --physical=========================================================================

In the case of the hard link, the path for the target is regarded as the physical name. When the path is a symbolic link, it is proceeded without being resolved.

--Example:[user@localhost ~]$ hln -P ...--

symlink-target-expand-relative#

=========================================================================Supported OS : Linux / WindowsFormat : --symlink-target-expand-relative=========================================================================

When the target is a relative path, this option tells the server to expand the relative path to an absolute path from a user working directory (home directory as usual) when creating a symbolic link.

--Example:[user@localhost ~]$ hln --symlink-target-expand-relative ...--

symlink-target-accept-expand-relative#

=========================================================================Supported OS : Linux / WindowsFormat : --symlink-target-accept-expand-relative=========================================================================

When the target is a relative path, this option tells the hln command to accept that the server expands the relative path to an absolute path. This option will works when the server is an old one and it dose not support to create symbolic links with relative paths in targets.

The hln command will stop without running when the server is enough older not to support to do and neither this option nor --symlink-target-expand-relative are specified.

--Example:[user@localhost ~]$ hln --symlink-target-accept-expand-relative ...--

host#

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

The remote host in the destination is specified. It is used in the path specifies the link target, link name, or the directory. With this parameter, the host name for this path can be omitted.

--Example:[user@localhost ~]$ hln --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 remote host in the destination is specified. It is used in the path specifies the link target, link name, or the directory.

--Example:[user@localhost ~]$ hln --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 creating links is set.

--Example:[user@localhost ~]$ hln --hcp-out=- ...TARGET0 127.0.0.1:1874:/home/user/Desktop/hcp_hln01.txtTARGET1 127.0.0.1:1874:/home/user/Desktop/hcp_hln02.txtLINK_NAME/DIR 127.0.0.1:1874:/home/user/Desktop/hcp_hln_dirOK 0000 FL 00000001 /home/user/Desktop/hcp_hln01.txtOK 0000 FL 00000002 /home/user/Desktop/hcp_hln02.txtEXIT 0 REASON 0000[user@localhost ~]$ --
--Example:[user@localhost ~]$ hln --hcp-out=- ...--

Software Information Update#

V, version#

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

The hln command version is shown.

--Example:[user@localhost ~]$ hln -Vhln client (hln) 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=========================================================================

The parameters and the configuration information for the hln command are output.

--Example:[user@localhost ~]$ hln --config-test...
Number of Logical Processors  : 2Number of Physical Processors : 2
Command parameters force     : disable interactive     : disable no-dereference     : disable symbolic     : disable logical     : disable physical     : enable host     : disable port     : disable user           : disable password       : disable version        : disable help           : disable
Target source:
Target destination:
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 hln command help is shown.

--Example:[user@localhost ~]$ hln -h--