aboutsummaryrefslogtreecommitdiff
path: root/include/fuse.h
diff options
context:
space:
mode:
authorGravatar Nikolaus Rath <Nikolaus@rath.org>2016-10-01 11:24:46 -0700
committerGravatar Nikolaus Rath <Nikolaus@rath.org>2016-10-01 11:24:46 -0700
commite20e5c9ae574bba8827310edf38ae9edca08c469 (patch)
treee248bdc392e09f5419dcced5c7dedde4972dff50 /include/fuse.h
parent944d1e1521935e82a3e667a401c7184467793ebc (diff)
Improve documentation of argument parsing.
Diffstat (limited to 'include/fuse.h')
-rw-r--r--include/fuse.h7
1 files changed, 7 insertions, 0 deletions
diff --git a/include/fuse.h b/include/fuse.h
index c70d2fe..5721caa 100644
--- a/include/fuse.h
+++ b/include/fuse.h
@@ -640,6 +640,13 @@ struct fuse_context {
/**
* Create a new FUSE filesystem.
*
+ * Known parameters in `args` are removed. If there are any unknown
+ * arguments, an error is printed to stderr and the function returns
+ * NULL.
+ *
+ * If the --help or --version parameters are specified, the function
+ * prints the requested information to stdout and returns NULL.
+ *
* @param ch the communication channel
* @param args argument vector
* @param op the filesystem operations