octoleo/s3fs-fuse
1
0
Fork 0
mirror of https://github.com/s3fs-fuse/s3fs-fuse.git synced 2025-01-11 00:21:45 +00:00
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #1011 from gaul/doc/man

Browse Source 
Make man page and --help more consistent
This commit is contained in:
Takeshi Nakatani 2019-04-16 23:07:17 +09:00 committed by GitHub
commit 7095787f1f
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 98 additions and 85 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

25
doc/man/s3fs.1
View File

@ -79,7 +79,7 @@ If this option is not specified, it will be created at runtime when the cache di
\fB\-o\fR del_cache - delete local file cache \fB\-o\fR del_cache - delete local file cache
delete local file cache when s3fs starts and exits. delete local file cache when s3fs starts and exits.
.TP .TP
\fB\-o\fR storage_class (default is standard) \fB\-o\fR storage_class (default="standard")
store object with specified storage class. store object with specified storage class.
this option replaces the old option use_rrs. this option replaces the old option use_rrs.
Possible values: standard, standard_ia, onezone_ia and reduced_redundancy. Possible values: standard, standard_ia, onezone_ia and reduced_redundancy.
@ -185,26 +185,29 @@ maximum number of parallel request for listing objects.
.TP .TP
\fB\-o\fR parallel_count (default="5") \fB\-o\fR parallel_count (default="5")
number of parallel request for uploading big objects. number of parallel request for uploading big objects.
s3fs uploads large object(default:over 20MB) by multipart post request, and sends parallel requests. s3fs uploads large object (over 20MB) by multipart post request, and sends parallel requests.
This option limits parallel request count which s3fs requests at once. This option limits parallel request count which s3fs requests at once.
It is necessary to set this value depending on a CPU and a network band. It is necessary to set this value depending on a CPU and a network band.
.TP .TP
\fB\-o\fR multipart_size(default="10"(10MB)) \fB\-o\fR multipart_size (default="10")
number of one part size in multipart uploading request. part size, in MB, for each multipart request.
The default size is 10MB(10485760byte), minimum value is 5MB(5242880byte). The minimum value is 5 MB and the maximum value is 5 GB.
Specify number of MB and over 5(MB).
.TP .TP
\fB\-o\fR ensure_diskfree (default 0) \fB\-o\fR ensure_diskfree (default 0)
sets MB to ensure disk free space. This option means the threshold of free space size on disk which is used for the cache file by s3fs. sets MB to ensure disk free space. This option means the threshold of free space size on disk which is used for the cache file by s3fs.
s3fs makes file for downloading, and uploading and caching files. s3fs makes file for downloading, uploading and caching files.
If the disk free space is smaller than this value, s3fs do not use diskspace as possible in exchange for the performance. If the disk free space is smaller than this value, s3fs do not use diskspace as possible in exchange for the performance.
.TP .TP
\fB\-o\fR singlepart_copy_limit (default="5120")
maximum size, in MB, of a single-part copy before trying
multipart copy.
.TP
\fB\-o\fR url (default="https://s3.amazonaws.com") \fB\-o\fR url (default="https://s3.amazonaws.com")
sets the url to use to access Amazon S3. If you want to use HTTP, then you can set "url=http://s3.amazonaws.com". sets the url to use to access Amazon S3. If you want to use HTTP, then you can set "url=http://s3.amazonaws.com".
If you do not use https, please specify the URL with the url option. If you do not use https, please specify the URL with the url option.
.TP .TP
\fB\-o\fR endpoint (default="us-east-1") \fB\-o\fR endpoint (default="us-east-1")
sets the endpoint to use. sets the endpoint to use on signature version 4.
If this option is not specified, s3fs uses "us-east-1" region as the default. If this option is not specified, s3fs uses "us-east-1" region as the default.
If the s3fs could not connect to the region specified by this option, s3fs could not run. If the s3fs could not connect to the region specified by this option, s3fs could not run.
But if you do not specify this option, and if you can not connect with the default region, s3fs will retry to automatically connect to the other region. But if you do not specify this option, and if you can not connect with the default region, s3fs will retry to automatically connect to the other region.
@ -217,7 +220,7 @@ sets signing AWS requests by using Signature Version 2.
sets umask for the mount point directory. sets umask for the mount point directory.
If allow_other option is not set, s3fs allows access to the mount point only to the owner. If allow_other option is not set, s3fs allows access to the mount point only to the owner.
In the opposite case s3fs allows access to all users as the default. In the opposite case s3fs allows access to all users as the default.
But if you set the allow_other with this option, you can control permissions of the mount point by this option like umask. But if you set the allow_other with this option, you can control the permissions of the mount point by this option like umask.
.TP .TP
\fB\-o\fR nomultipart - disable multipart uploads \fB\-o\fR nomultipart - disable multipart uploads
.TP .TP
@ -235,7 +238,7 @@ This option requires the IAM role name or "auto". If you specify "auto", s3fs wi
This option instructs s3fs to use IBM IAM authentication. In this mode, the AWSAccessKey and AWSSecretKey will be used as IBM's Service-Instance-ID and APIKey, respectively. This option instructs s3fs to use IBM IAM authentication. In this mode, the AWSAccessKey and AWSSecretKey will be used as IBM's Service-Instance-ID and APIKey, respectively.
.TP .TP
\fB\-o\fR ibm_iam_endpoint (default is https://iam.bluemix.net) \fB\-o\fR ibm_iam_endpoint (default is https://iam.bluemix.net)
Set the URL to use for IBM IAM authentication. Sets the URL to use for IBM IAM authentication.
.TP .TP
\fB\-o\fR use_xattr (default is not handling the extended attribute) \fB\-o\fR use_xattr (default is not handling the extended attribute)
Enable to handle the extended attribute (xattrs). Enable to handle the extended attribute (xattrs).
@ -264,7 +267,7 @@ Usually s3fs outputs of the User-Agent in "s3fs/<version> (commit hash <hash>; <
If this option is specified, s3fs suppresses the output of the User-Agent. If this option is specified, s3fs suppresses the output of the User-Agent.
.TP .TP
\fB\-o\fR cipher_suites \fB\-o\fR cipher_suites
Customize TLS cipher suite list. Expects a colon separated list of cipher suite names. Customize the list of TLS cipher suites. Expects a colon separated list of cipher suite names.
A list of available cipher suites, depending on your TLS engine, can be found on the CURL library documentation: A list of available cipher suites, depending on your TLS engine, can be found on the CURL library documentation:
https://curl.haxx.se/docs/ssl-ciphers.html https://curl.haxx.se/docs/ssl-ciphers.html
.TP .TP

46
src/s3fs_util.cpp
View File

@ -993,7 +993,7 @@ void show_help ()
" s3fs bucket[:/path] mountpoint [options]\n" " s3fs bucket[:/path] mountpoint [options]\n"
" s3fs mountpoint [options (must specify bucket= option)]\n" " s3fs mountpoint [options (must specify bucket= option)]\n"
"\n" "\n"
" umounting\n" " unmounting\n"
" umount mountpoint\n" " umount mountpoint\n"
"\n" "\n"
" General forms for s3fs and FUSE/mount options:\n" " General forms for s3fs and FUSE/mount options:\n"
@ -1022,14 +1022,14 @@ void show_help ()
" for the full list of canned acls\n" " for the full list of canned acls\n"
"\n" "\n"
" retries (default=\"5\")\n" " retries (default=\"5\")\n"
" - number of times to retry a failed s3 transaction\n" " - number of times to retry a failed S3 transaction\n"
"\n" "\n"
" use_cache (default=\"\" which means disabled)\n" " use_cache (default=\"\" which means disabled)\n"
" - local folder to use for local file cache\n" " - local folder to use for local file cache\n"
"\n" "\n"
" check_cache_dir_exist (default is disable)\n" " check_cache_dir_exist (default is disable)\n"
" - if use_cache is set, check if the cache directory exists.\n" " - if use_cache is set, check if the cache directory exists.\n"
" if this option is not specified, it will be created at runtime\n" " If this option is not specified, it will be created at runtime\n"
" when the cache directory does not exist.\n" " when the cache directory does not exist.\n"
"\n" "\n"
" del_cache (delete local file cache)\n" " del_cache (delete local file cache)\n"
@ -1139,6 +1139,13 @@ void show_help ()
" - specify expire time (seconds) for entries in the stat cache.\n" " - specify expire time (seconds) for entries in the stat cache.\n"
" This expire time indicates the time since stat cached.\n" " This expire time indicates the time since stat cached.\n"
"\n" "\n"
" stat_cache_interval_expire (default is no expire)\n"
" - specify expire time (seconds) for entries in the stat cache.\n"
" This expire time is based on the time from the last access time\n"
" of the stat cache. This option is exclusive with\n"
" stat_cache_expire, and is left for compatibility with older\n"
" versions.\n"
"\n"
" enable_noobj_cache (default is disable)\n" " enable_noobj_cache (default is disable)\n"
" - enable cache entries for the object which does not exist.\n" " - enable cache entries for the object which does not exist.\n"
" s3fs always has to check whether file (or sub directory) exists \n" " s3fs always has to check whether file (or sub directory) exists \n"
@ -1173,9 +1180,12 @@ void show_help ()
"\n" "\n"
" multipart_size (default=\"10\")\n" " multipart_size (default=\"10\")\n"
" - part size, in MB, for each multipart request.\n" " - part size, in MB, for each multipart request.\n"
" The minimum value is 5 MB and the maximum value is 5 GB.\n"
"\n" "\n"
" ensure_diskfree (default 0)\n" " ensure_diskfree (default 0)\n"
" - sets MB to ensure disk free space. s3fs makes file for\n" " - sets MB to ensure disk free space. This option means the\n"
" threshold of free space size on disk which is used for the\n"
" cache file by s3fs. s3fs makes file for\n"
" downloading, uploading and caching files. If the disk free\n" " downloading, uploading and caching files. If the disk free\n"
" space is smaller than this value, s3fs do not use diskspace\n" " space is smaller than this value, s3fs do not use diskspace\n"
" as possible in exchange for the performance.\n" " as possible in exchange for the performance.\n"
@ -1217,7 +1227,7 @@ void show_help ()
" Allow S3 server to check data integrity of uploads via the\n" " Allow S3 server to check data integrity of uploads via the\n"
" Content-MD5 header. This can add CPU overhead to transfers.\n" " Content-MD5 header. This can add CPU overhead to transfers.\n"
"\n" "\n"
" ecs\n" " ecs (default is disable)\n"
" - This option instructs s3fs to query the ECS container credential\n" " - This option instructs s3fs to query the ECS container credential\n"
" metadata address instead of the instance metadata address.\n" " metadata address instead of the instance metadata address.\n"
"\n" "\n"
@ -1227,13 +1237,13 @@ void show_help ()
" to an instance. If you specify this option without any argument, it\n" " to an instance. If you specify this option without any argument, it\n"
" is the same as that you have specified the \"auto\".\n" " is the same as that you have specified the \"auto\".\n"
"\n" "\n"
" ibm_iam_auth\n" " ibm_iam_auth (default is not using IBM IAM authentication)\n"
" - This option instructs s3fs to use IBM IAM authentication.\n" " - This option instructs s3fs to use IBM IAM authentication.\n"
" In this mode, the AWSAccessKey and AWSSecretKey will be used as\n" " In this mode, the AWSAccessKey and AWSSecretKey will be used as\n"
" IBM's Service-Instance-ID and APIKey, respectively.\n" " IBM's Service-Instance-ID and APIKey, respectively.\n"
"\n" "\n"
" ibm_iam_endpoint (default is https://iam.bluemix.net)\n" " ibm_iam_endpoint (default is https://iam.bluemix.net)\n"
" - sets the url to use for IBM IAM authentication.\n" " - sets the URL to use for IBM IAM authentication.\n"
"\n" "\n"
" use_xattr (default is not handling the extended attribute)\n" " use_xattr (default is not handling the extended attribute)\n"
" Enable to handle the extended attribute (xattrs).\n" " Enable to handle the extended attribute (xattrs).\n"
@ -1276,17 +1286,7 @@ void show_help ()
" If this option is specified, s3fs suppresses the output of the\n" " If this option is specified, s3fs suppresses the output of the\n"
" User-Agent.\n" " User-Agent.\n"
"\n" "\n"
" dbglevel (default=\"crit\")\n" " cipher_suites\n"
" Set the debug message level. set value as crit(critical), err\n"
" (error), warn(warning), info(information) to debug level.\n"
" default debug level is critical. If s3fs run with \"-d\" option,\n"
" the debug level is set information. When s3fs catch the signal\n"
" SIGUSR2, the debug level is bumpup.\n"
"\n"
" curldbg - put curl debug message\n"
" Put the debug message from libcurl when this option is specified.\n"
"\n"
" cipher_suites - customize TLS cipher suite list\n"
" Customize the list of TLS cipher suites.\n" " Customize the list of TLS cipher suites.\n"
" Expects a colon separated list of cipher suite names.\n" " Expects a colon separated list of cipher suite names.\n"
" A list of available cipher suites, depending on your TLS engine,\n" " A list of available cipher suites, depending on your TLS engine,\n"
@ -1329,6 +1329,16 @@ void show_help ()
" Unicode set.\n" " Unicode set.\n"
" Useful on clients not using utf-8 as their file system encoding.\n" " Useful on clients not using utf-8 as their file system encoding.\n"
"\n" "\n"
" dbglevel (default=\"crit\")\n"
" Set the debug message level. set value as crit (critical), err\n"
" (error), warn (warning), info (information) to debug level.\n"
" default debug level is critical. If s3fs run with \"-d\" option,\n"
" the debug level is set information. When s3fs catch the signal\n"
" SIGUSR2, the debug level is bumpup.\n"
"\n"
" curldbg - put curl debug message\n"
" Put the debug message from libcurl when this option is specified.\n"
"\n"
"FUSE/mount Options:\n" "FUSE/mount Options:\n"
"\n" "\n"
" Most of the generic mount options described in 'man mount' are\n" " Most of the generic mount options described in 'man mount' are\n"