[27559] in Source-Commits
pyhesiodfs commit: Add a sample config file; update manpage
daemon@ATHENA.MIT.EDU (Jonathan D Reed)
Tue Dec 31 12:27:31 2013
Date: Tue, 31 Dec 2013 12:27:24 -0500
From: Jonathan D Reed <jdreed@MIT.EDU>
Message-Id: <201312311727.rBVHRO11027126@drugstore.mit.edu>
To: source-commits@MIT.EDU
https://github.com/mit-athena/pyhesiodfs/commit/11cd6aaa5b5a3634df48b36e0d2945a29ba4cc6e
commit 11cd6aaa5b5a3634df48b36e0d2945a29ba4cc6e
Author: Jonathan Reed <jdreed@mit.edu>
Date: Thu Nov 14 15:38:12 2013 -0500
Add a sample config file; update manpage
- Add a sample config.ini and install it with the docs.
- Mention sample config file in manpage (and clean up the
man page while we're at it.)
debian/debathena-pyhesiodfs.docs | 1 +
debian/pyhesiodfs.1 | 16 +++++++++++++---
debian/sample_config.ini | 29 +++++++++++++++++++++++++++++
3 files changed, 43 insertions(+), 3 deletions(-)
diff --git a/debian/debathena-pyhesiodfs.docs b/debian/debathena-pyhesiodfs.docs
new file mode 100644
index 0000000..34f2230
--- /dev/null
+++ b/debian/debathena-pyhesiodfs.docs
@@ -0,0 +1 @@
+debian/sample_config.ini
diff --git a/debian/pyhesiodfs.1 b/debian/pyhesiodfs.1
index 7200a95..f4b0d3c 100644
--- a/debian/pyhesiodfs.1
+++ b/debian/pyhesiodfs.1
@@ -10,10 +10,9 @@ pyhesiodfs \- PythonFUSE-based automounter for /mit
uses the Python FUSE API to create a FUSE ("Filesystem in Userspace")
filesystem mounted on /mit, which automatically looks up locker names
in Hesiod and creates the necessary symlinks to the path in AFS. It
-is the user's responsibility to obtain the necessary AFS tokens, though this is usually done at login time by PAM.
+is the user's responsibility to obtain the necessary AFS tokens, though
+this is usually done at login time by PAM.
-Really, you should never need to run this command by hand, and the
-only reason this man page exists is because Debian Policy requires it.
.SH OPTIONS
Most options are passed directly to the Python FUSE option parser.
Consult that documentation for the appropriate options.
@@ -21,10 +20,21 @@ Consult that documentation for the appropriate options.
On Debathena, it is typically invoked as:
.B pyhesiodfs -f /mit -o nonempty
+.SH CONFIGURATION
+There is an optional config file, with inline documentation, installed
+at wherever your distribution installs documentation (probably
+/usr/share/doc). Go read it.
+
.SH FILES
.I /etc/fuse.conf
.RS
Actually provided by fuse-utils, but diverted by the debathena-pyhesiodfs package.
+.RE
+
+.I /etc/pyhesiodfs/config.ini
+.RS
+The (optional) config file. See above.
+
.SH BUGS
Probably.
.SH AUTHOR
diff --git a/debian/sample_config.ini b/debian/sample_config.ini
new file mode 100644
index 0000000..58f4ee4
--- /dev/null
+++ b/debian/sample_config.ini
@@ -0,0 +1,29 @@
+# This is a sample pyhesiodfs config file. It has one section
+# ('PyHesiodFS'). All values shown here are defaults.
+[PyHesiodFS]
+# syslog on unavailable lockers?
+syslog_unavail = true
+
+# syslog on unknown lockers?
+syslog_unknown = true
+
+# syslog on sucessful symlink creation?
+syslog_success = false
+
+# Show a "README"-esque file in the filesystem
+show_readme = false
+
+# Filename of the aforementioned file
+readme_filename = README.txt
+
+# Contents of the aforementioned file
+# This is a multi-line string. Each subsequent line must be indented.
+# '{mountpoint}' will be replaced with the mountpoint of the filesystem
+# '{blank}' will be replaced by whitespace. A trailing newline
+# will be added to the file.
+readme_contents = This is the pyhesiodfs FUSE autmounter.
+ {blank}
+ To access a Hesiod filsys, just access {mountpoint}/name.
+ {blank}
+ If you're using the Finder, try pressing Cmd+Shift+G and then
+ entering {mountpoint}/name
