diff --git a/README.md b/README.md index e5666e6..6c3bcce 100644 --- a/README.md +++ b/README.md @@ -192,7 +192,7 @@ Depending on your performance requirements and your specific bottlenecks, the fo - Using XDP in zero-copy mode can substantially improve performance, but whether it is supported depends on the combination of network card and driver in your setup. Hercules will attempt to use zero-copy mode automatically, if it appears to be supported. Note that some network cards require updating drivers/firmware to enable zero-copy mode. - Using larger packets (jumbo frames) can also improve performance. Hercules supports jumbo frames up to a MTU of 9000 bytes. Note, however, that support for jumbo frames (via XDP multibuffer/fragments) requires at least kernel 6.6. On older versions the packet size is limited to 3000 bytes. - Further, support for jumbo frames in combination with zero-copy mode is device-dependent. To use jumbo frames on such a device, disable zero-copy in Hercules' file. + Further, support for jumbo frames in combination with zero-copy mode is device-dependent. To use jumbo frames on a device that does not support jumbo frames in zero-copy mode, disable zero-copy in Hercules' configuration file. - Increasing the number of worker threads via the option `NumThreads` can also improve performance. diff --git a/doc/hercules-monitor.1 b/doc/hercules-monitor.1 index a267392..8754c3b 100644 --- a/doc/hercules-monitor.1 +++ b/doc/hercules-monitor.1 @@ -11,7 +11,7 @@ .Ek .Sh DESCRIPTION .Nm -is the monitor component of the Hercules file transfer sytem. +is the monitor component of the Hercules file transfer system. The monitor is the link between users and the Hercules server. Users interact with the monitor via its HTTP API. The monitor interacts with the server component via a local Unix socket. diff --git a/doc/hercules-monitor.1.md b/doc/hercules-monitor.1.md index e1941d1..53037d3 100644 --- a/doc/hercules-monitor.1.md +++ b/doc/hercules-monitor.1.md @@ -12,7 +12,7 @@ HERCULES-MONITOR(1) - General Commands Manual # DESCRIPTION **hercules-monitor** -is the monitor component of the Hercules file transfer sytem. +is the monitor component of the Hercules file transfer system. The monitor is the link between users and the Hercules server. Users interact with the monitor via its HTTP API. The monitor interacts with the server component via a local Unix socket. diff --git a/doc/hercules-server.1 b/doc/hercules-server.1 index 96d5917..fb24b85 100644 --- a/doc/hercules-server.1 +++ b/doc/hercules-server.1 @@ -11,7 +11,7 @@ .Ek .Sh DESCRIPTION .Nm -is the server component of the Hercules file transfer sytem. +is the server component of the Hercules file transfer system. The server's task is to run the actual file transfers. The server receives tasks from the monitor and informs the monitor of transfer progress via a local Unix socket. diff --git a/doc/hercules-server.1.md b/doc/hercules-server.1.md index 5e79da1..6570eef 100644 --- a/doc/hercules-server.1.md +++ b/doc/hercules-server.1.md @@ -12,7 +12,7 @@ HERCULES-SERVER(1) - General Commands Manual # DESCRIPTION **hercules-server** -is the server component of the Hercules file transfer sytem. +is the server component of the Hercules file transfer system. The server's task is to run the actual file transfers. The server receives tasks from the monitor and informs the monitor of transfer progress via a local Unix socket. diff --git a/doc/hercules.conf.5 b/doc/hercules.conf.5 index 34b17f6..35cc83e 100644 --- a/doc/hercules.conf.5 +++ b/doc/hercules.conf.5 @@ -45,7 +45,7 @@ for more information. The following general configuration options are available: .Bl -tag -width Ds .It Ic DefaultNumPaths Ns = Ns Ar int -Specify how many SCION path to use for data transfers. +Specify how many SCION paths to use for data transfers. This is an upper limit, if fewer paths are available only those will be used. This value may be overridden on a per-destination basis, see .Sx PER-DESTINATION OVERRIDES . @@ -89,7 +89,7 @@ for more information. When setting this option, note that the file paths supplied by users will be interpreted relative to this new directory. .Pp -Example: DropUser = "/mnt/data/" +Example: ChrootDir = "/mnt/data/" .It Ic EnablePCC Ns = Ns Ar bool Setting this option to .Ar false @@ -236,7 +236,7 @@ For transfers to any other host in AS .Em 18-a:b:c : .Bl -bullet -compact .It -A payload length of 1400 should be used. +A payload length of 1400B should be used. .El .El .Pp diff --git a/doc/hercules.conf.5.md b/doc/hercules.conf.5.md index 0ccde29..11c75f8 100644 --- a/doc/hercules.conf.5.md +++ b/doc/hercules.conf.5.md @@ -49,7 +49,7 @@ The following general configuration options are available: **DefaultNumPaths**=*int* -> Specify how many SCION path to use for data transfers. +> Specify how many SCION paths to use for data transfers. > This is an upper limit, if fewer paths are available only those will be used. > This value may be overridden on a per-destination basis, see > *PER-DESTINATION OVERRIDES*. @@ -103,7 +103,7 @@ The following general configuration options are available: > When setting this option, note that the file paths supplied by users will be > interpreted relative to this new directory. -> Example: DropUser = "/mnt/data/" +> Example: ChrootDir = "/mnt/data/" **EnablePCC**=*bool* @@ -271,7 +271,7 @@ Example: The following set of rules specifies that * For transfers to any other host in AS *18-a:b:c*: - * A payload length of 1400 should be used. + * A payload length of 1400B should be used. Example: