[#14] Add docs for kludge14 flag

Signed-off-by: Aleksey Kravchenko <al.kravchenko@yadro.com>
2025-02-17 09:44:33 +03:00 · 2025-02-17 09:44:33 +03:00 · 74f2ea368f
commit 74f2ea368f
parent db9797d736
7 changed files with 96 additions and 15 deletions
--- a/MANUAL.html
+++ b/MANUAL.html
@ -233,7 +233,7 @@
 <header id="title-block-header">
 <h1 class="title">rclone(1) User Manual</h1>
 <p class="author">Nick Craig-Wood</p>
-<p class="date">Jan 23, 2025</p>
+<p class="date">Feb 17, 2025</p>
 </header>
 <h1 id="rclone-syncs-your-files-to-cloud-storage">Rclone syncs your
 files to cloud storage</h1>
@ -19294,7 +19294,7 @@ split into groups.</p>
      --tpslimit float                     Limit HTTP transactions per second to this
      --tpslimit-burst int                 Max burst of transactions for --tpslimit (default 1)
      --use-cookies                        Enable session cookiejar
-      --user-agent string                  Set the user-agent to a specified string (default &quot;rclone/v1.68.2-beta.8335.a85292ca0.feature/add-container-zones-support&quot;)</code></pre>
+      --user-agent string                  Set the user-agent to a specified string (default &quot;rclone/v1.68.2-beta.8335.12b572e62.feat/frostfs_kludge_14&quot;)</code></pre>
 <h2 id="performance">Performance</h2>
 <p>Flags helpful for increasing performance.</p>
 <pre><code>      --buffer-size SizeSuffix   In memory buffer size when reading files for each --transfer (default 16Mi)
@ -19680,6 +19680,7 @@ split into groups.</p>
      --frostfs-default-container-zone string               The name of the zone in which containers will be created or resolved if the zone name is not explicitly specified with the container name (default &quot;container&quot;)
      --frostfs-description string                          Description of the remote
      --frostfs-endpoint string                             Endpoints to connect to FrostFS node
+      --frostfs-kludge14                                    Store the file name in the FilePath attribute
      --frostfs-password string                             Password to decrypt wallet
      --frostfs-placement-policy string                     Placement policy for new containers (default &quot;REP 3&quot;)
      --frostfs-rebalance-interval Duration                 FrostFS rebalance connections interval (default 15s)
@ -32927,7 +32928,7 @@ Configuration complete.
 Options:
 - type: frostfs
 - endpoint: s01.frostfs.devenv:8080,1 s02.frostfs.devenv:8080,2
- password: M@zPGpWDravchenko/develop/go/playground/play_with_ape/cfg/wallet_akrav.js
+- password: M@zPGpWD
 - placement_policy: REP 1
 Keep this &quot;remote&quot; remote?
 y) Yes this is OK (default)
@ -32951,6 +32952,10 @@ container:</p>
 <p>If the zone is not explicitly specified, its name will be obtained
 from the configuration parameter
 <code>default_container_zone</code>.</p>
+<p>For compatibility purposes, a "kludge14" flag has been added to the
+"advanced config" section. This flag forces the full path of the file to
+be stored in the "FileName" object attribute. If this flag is disabled,
+only the name of the file will be stored without the path.</p>
 <h3 id="standard-options-14">Standard options</h3>
 <p>Here are the Standard options specific to frostfs (Distributed,
 decentralized object storage FrostFS).</p>
@ -33146,6 +33151,15 @@ read</li>
 <h3 id="advanced-options-14">Advanced options</h3>
 <p>Here are the Advanced options specific to frostfs (Distributed,
 decentralized object storage FrostFS).</p>
+<h4 id="frostfs-kludge14">--frostfs-kludge14</h4>
+<p>Store the file name in the FilePath attribute</p>
+<p>Properties:</p>
+<ul>
+<li>Config: kludge14</li>
+<li>Env Var: RCLONE_FROSTFS_KLUDGE14</li>
+<li>Type: bool</li>
+<li>Default: false</li>
+</ul>
 <h4 id="frostfs-description">--frostfs-description</h4>
 <p>Description of the remote.</p>
 <p>Properties:</p>
--- a/MANUAL.md
+++ b/MANUAL.md
@ -1,6 +1,6 @@
 % rclone(1) User Manual
 % Nick Craig-Wood
-% Jan 23, 2025
+% Feb 17, 2025

 # Rclone syncs your files to cloud storage

@ -20498,7 +20498,7 @@ Flags for general networking and HTTP stuff.
      --tpslimit float                     Limit HTTP transactions per second to this
      --tpslimit-burst int                 Max burst of transactions for --tpslimit (default 1)
      --use-cookies                        Enable session cookiejar
-      --user-agent string                  Set the user-agent to a specified string (default "rclone/v1.68.2-beta.8335.a85292ca0.feature/add-container-zones-support")
+      --user-agent string                  Set the user-agent to a specified string (default "rclone/v1.68.2-beta.8335.12b572e62.feat/frostfs_kludge_14")
 ```


@ -20944,6 +20944,7 @@ Backend-only flags (these can be set in the config file also).
      --frostfs-default-container-zone string               The name of the zone in which containers will be created or resolved if the zone name is not explicitly specified with the container name (default "container")
      --frostfs-description string                          Description of the remote
      --frostfs-endpoint string                             Endpoints to connect to FrostFS node
+      --frostfs-kludge14                                    Store the file name in the FilePath attribute
      --frostfs-password string                             Password to decrypt wallet
      --frostfs-placement-policy string                     Placement policy for new containers (default "REP 3")
      --frostfs-rebalance-interval Duration                 FrostFS rebalance connections interval (default 15s)
@ -34873,7 +34874,7 @@ Configuration complete.
 Options:
 - type: frostfs
 - endpoint: s01.frostfs.devenv:8080,1 s02.frostfs.devenv:8080,2
- password: M@zPGpWDravchenko/develop/go/playground/play_with_ape/cfg/wallet_akrav.js
+- password: M@zPGpWD
 - placement_policy: REP 1
 Keep this "remote" remote?
 y) Yes this is OK (default)
@ -34900,6 +34901,8 @@ to create or search for a container:
 If the zone is not explicitly specified, its name will be obtained from the configuration parameter
 `default_container_zone`.   

+For compatibility purposes, a "kludge14" flag has been added to the "advanced config" section. This flag forces the full path of the file to be stored in the "FileName" object attribute. If this flag is disabled, only the name of the file will be stored without the path.
+

 ### Standard options

@ -35093,6 +35096,17 @@ Properties:

 Here are the Advanced options specific to frostfs (Distributed, decentralized object storage FrostFS).

+#### --frostfs-kludge14
+
+Store the file name in the FilePath attribute
+
+Properties:
+
+- Config:      kludge14
+- Env Var:     RCLONE_FROSTFS_KLUDGE14
+- Type:        bool
+- Default:     false
+
 #### --frostfs-description

 Description of the remote.
--- a/MANUAL.txt
+++ b/MANUAL.txt
@ -1,6 +1,6 @@
 rclone(1) User Manual
 Nick Craig-Wood
-Jan 23, 2025
+Feb 17, 2025

 Rclone syncs your files to cloud storage

@ -20166,7 +20166,7 @@ Flags for general networking and HTTP stuff.
          --tpslimit float                     Limit HTTP transactions per second to this
          --tpslimit-burst int                 Max burst of transactions for --tpslimit (default 1)
          --use-cookies                        Enable session cookiejar
-          --user-agent string                  Set the user-agent to a specified string (default "rclone/v1.68.2-beta.8335.a85292ca0.feature/add-container-zones-support")
+          --user-agent string                  Set the user-agent to a specified string (default "rclone/v1.68.2-beta.8335.12b572e62.feat/frostfs_kludge_14")

 Performance

@ -20582,6 +20582,7 @@ Backend-only flags (these can be set in the config file also).
          --frostfs-default-container-zone string               The name of the zone in which containers will be created or resolved if the zone name is not explicitly specified with the container name (default "container")
          --frostfs-description string                          Description of the remote
          --frostfs-endpoint string                             Endpoints to connect to FrostFS node
+          --frostfs-kludge14                                    Store the file name in the FilePath attribute
          --frostfs-password string                             Password to decrypt wallet
          --frostfs-placement-policy string                     Placement policy for new containers (default "REP 3")
          --frostfs-rebalance-interval Duration                 FrostFS rebalance connections interval (default 15s)
@ -34335,7 +34336,7 @@ FrostFS user wallet.
    Options:
    - type: frostfs
    - endpoint: s01.frostfs.devenv:8080,1 s02.frostfs.devenv:8080,2
-    - password: M@zPGpWDravchenko/develop/go/playground/play_with_ape/cfg/wallet_akrav.js
+    - password: M@zPGpWD
    - placement_policy: REP 1
    Keep this "remote" remote?
    y) Yes this is OK (default)
@ -34363,6 +34364,11 @@ name of the zone in which you want to create or search for a container:
 If the zone is not explicitly specified, its name will be obtained from
 the configuration parameter default_container_zone.

+For compatibility purposes, a "kludge14" flag has been added to the
+"advanced config" section. This flag forces the full path of the file to
+be stored in the "FileName" object attribute. If this flag is disabled,
+only the name of the file will be stored without the path.
+
 Standard options

 Here are the Standard options specific to frostfs (Distributed,
@ -34564,6 +34570,17 @@ Advanced options
 Here are the Advanced options specific to frostfs (Distributed,
 decentralized object storage FrostFS).

+--frostfs-kludge14
+
+Store the file name in the FilePath attribute
+
+Properties:
+
+-   Config: kludge14
+-   Env Var: RCLONE_FROSTFS_KLUDGE14
+-   Type: bool
+-   Default: false
+
 --frostfs-description

 Description of the remote.
--- a/docs/content/commands/rclone.md
+++ b/docs/content/commands/rclone.md
@ -305,6 +305,7 @@ rclone [flags]
      --frostfs-default-container-zone string               The name of the zone in which containers will be created or resolved if the zone name is not explicitly specified with the container name (default "container")
      --frostfs-description string                          Description of the remote
      --frostfs-endpoint string                             Endpoints to connect to FrostFS node
+      --frostfs-kludge14                                    Store the file name in the FilePath attribute
      --frostfs-password string                             Password to decrypt wallet
      --frostfs-placement-policy string                     Placement policy for new containers (default "REP 3")
      --frostfs-rebalance-interval Duration                 FrostFS rebalance connections interval (default 15s)
@ -945,7 +946,7 @@ rclone [flags]
      --use-json-log                                        Use json log format
      --use-mmap                                            Use mmap allocator (see docs)
      --use-server-modtime                                  Use server modified time instead of object metadata
-      --user-agent string                                   Set the user-agent to a specified string (default "rclone/v1.68.2-beta.8335.a85292ca0.feature/add-container-zones-support")
+      --user-agent string                                   Set the user-agent to a specified string (default "rclone/v1.68.2-beta.8335.12b572e62.feat/frostfs_kludge_14")
  -v, --verbose count                                       Print lots more stuff (repeat for more)
  -V, --version                                             Print the version number
      --webdav-bearer-token string                          Bearer token instead of user/pass (e.g. a Macaroon)
--- a/docs/content/flags.md
+++ b/docs/content/flags.md
@ -115,7 +115,7 @@ Flags for general networking and HTTP stuff.
      --tpslimit float                     Limit HTTP transactions per second to this
      --tpslimit-burst int                 Max burst of transactions for --tpslimit (default 1)
      --use-cookies                        Enable session cookiejar
-      --user-agent string                  Set the user-agent to a specified string (default "rclone/v1.68.2-beta.8335.a85292ca0.feature/add-container-zones-support")
+      --user-agent string                  Set the user-agent to a specified string (default "rclone/v1.68.2-beta.8335.12b572e62.feat/frostfs_kludge_14")
 ```


@ -561,6 +561,7 @@ Backend-only flags (these can be set in the config file also).
      --frostfs-default-container-zone string               The name of the zone in which containers will be created or resolved if the zone name is not explicitly specified with the container name (default "container")
      --frostfs-description string                          Description of the remote
      --frostfs-endpoint string                             Endpoints to connect to FrostFS node
+      --frostfs-kludge14                                    Store the file name in the FilePath attribute
      --frostfs-password string                             Password to decrypt wallet
      --frostfs-placement-policy string                     Placement policy for new containers (default "REP 3")
      --frostfs-rebalance-interval Duration                 FrostFS rebalance connections interval (default 15s)
--- a/docs/content/frostfs.md
+++ b/docs/content/frostfs.md
@ -256,7 +256,7 @@ Configuration complete.
 Options:
 - type: frostfs
 - endpoint: s01.frostfs.devenv:8080,1 s02.frostfs.devenv:8080,2
- password: M@zPGpWDravchenko/develop/go/playground/play_with_ape/cfg/wallet_akrav.js
+- password: M@zPGpWD
 - placement_policy: REP 1
 Keep this "remote" remote?
 y) Yes this is OK (default)
@ -283,6 +283,8 @@ to create or search for a container:
 If the zone is not explicitly specified, its name will be obtained from the configuration parameter
 `default_container_zone`.   

+For compatibility purposes, a "kludge14" flag has been added to the "advanced config" section. This flag forces the full path of the file to be stored in the "FileName" object attribute. If this flag is disabled, only the name of the file will be stored without the path.
+
 {{< rem autogenerated options start" - DO NOT EDIT - instead edit fs.RegInfo in backend/frostfs/frostfs.go then run make backenddocs" >}}
 ### Standard options

@ -476,6 +478,17 @@ Properties:

 Here are the Advanced options specific to frostfs (Distributed, decentralized object storage FrostFS).

+#### --frostfs-kludge14
+
+Store the file name in the FilePath attribute
+
+Properties:
+
+- Config:      kludge14
+- Env Var:     RCLONE_FROSTFS_KLUDGE14
+- Type:        bool
+- Default:     false
+
 #### --frostfs-description

 Description of the remote.
--- a/rclone.1
+++ b/rclone.1
@ -15,7 +15,7 @@
 . ftr VB CB
 . ftr VBI CBI
 .\}
-.TH "rclone" "1" "Jan 23, 2025" "User Manual" ""
+.TH "rclone" "1" "Feb 17, 2025" "User Manual" ""
 .hy
 .SH Rclone syncs your files to cloud storage
 .PP
@ -27735,7 +27735,7 @@ Flags for general networking and HTTP stuff.
      --tpslimit float                     Limit HTTP transactions per second to this
      --tpslimit-burst int                 Max burst of transactions for --tpslimit (default 1)
      --use-cookies                        Enable session cookiejar
-      --user-agent string                  Set the user-agent to a specified string (default \[dq]rclone/v1.68.2-beta.8335.a85292ca0.feature/add-container-zones-support\[dq])
+      --user-agent string                  Set the user-agent to a specified string (default \[dq]rclone/v1.68.2-beta.8335.12b572e62.feat/frostfs_kludge_14\[dq])
 \f[R]
 .fi
 .SS Performance
@ -28181,6 +28181,7 @@ Backend-only flags (these can be set in the config file also).
      --frostfs-default-container-zone string               The name of the zone in which containers will be created or resolved if the zone name is not explicitly specified with the container name (default \[dq]container\[dq])
      --frostfs-description string                          Description of the remote
      --frostfs-endpoint string                             Endpoints to connect to FrostFS node
+      --frostfs-kludge14                                    Store the file name in the FilePath attribute
      --frostfs-password string                             Password to decrypt wallet
      --frostfs-placement-policy string                     Placement policy for new containers (default \[dq]REP 3\[dq])
      --frostfs-rebalance-interval Duration                 FrostFS rebalance connections interval (default 15s)
@ -45772,7 +45773,7 @@ Configuration complete.
 Options:
 - type: frostfs
 - endpoint: s01.frostfs.devenv:8080,1 s02.frostfs.devenv:8080,2
- password: M\[at]zPGpWDravchenko/develop/go/playground/play_with_ape/cfg/wallet_akrav.js
+- password: M\[at]zPGpWD
 - placement_policy: REP 1
 Keep this \[dq]remote\[dq] remote?
 y) Yes this is OK (default)
@ -45809,6 +45810,13 @@ rclone copy \[ti]/test-copy remote:container-name.container-zone/test-copy
 .PP
 If the zone is not explicitly specified, its name will be obtained from
 the configuration parameter \f[V]default_container_zone\f[R].
+.PP
+For compatibility purposes, a \[dq]kludge14\[dq] flag has been added to
+the \[dq]advanced config\[dq] section.
+This flag forces the full path of the file to be stored in the
+\[dq]FileName\[dq] object attribute.
+If this flag is disabled, only the name of the file will be stored
+without the path.
 .SS Standard options
 .PP
 Here are the Standard options specific to frostfs (Distributed,
@ -46077,6 +46085,19 @@ Private container, only owner has access to it
 .PP
 Here are the Advanced options specific to frostfs (Distributed,
 decentralized object storage FrostFS).
+.SS --frostfs-kludge14
+.PP
+Store the file name in the FilePath attribute
+.PP
+Properties:
+.IP \[bu] 2
+Config: kludge14
+.IP \[bu] 2
+Env Var: RCLONE_FROSTFS_KLUDGE14
+.IP \[bu] 2
+Type: bool
+.IP \[bu] 2
+Default: false
 .SS --frostfs-description
 .PP
 Description of the remote.