[PATCH] manpage consistency Ecryptfs had a single pod-style manpage for ecryptfs(7), versus 17 roof-style manpages.
This is rather ugly, and inconsistent, and makes for a strange special case in the build. In this patch, I have manually ported the lone pod manpage over to roff format, and updated the Makefile.am accordingly. Please add ecryptfs.7 to git, and remove ecryptfs.pod. Thanks, -- :-Dustin Dustin Kirkland Ubuntu Server Developer Canonical, LTD [EMAIL PROTECTED] GPG: 1024D/83A61194
--- a/doc/manpage/Makefile.am +++ b/doc/manpage/Makefile.am @@ -9,10 +9,10 @@ # implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. MAINTAINERCLEANFILES = $(srcdir)/Makefile.in -DISTCLEANFILES = ecryptfs.7 dist_noinst_DATA = ecryptfs.pod dist_man_MANS = \ + ecryptfs.7 \ ecryptfs-add-passphrase.1 \ ecryptfsd.8 \ ecryptfs-generate-tpm-key.1 \ @@ -30,8 +30,3 @@ dist_man_MANS = \ mount.ecryptfs_private.1 \ pam_ecryptfs.8 \ umount.ecryptfs_private.1 - -ecryptfs.7: $(srcdir)/ecryptfs.pod - $(POD2MAN) \ - --center="eCryptfs" --section=7 \ - --release=$(PACKAGE_VERSION) $(srcdir)/ecryptfs.pod > ecryptfs.7 --- a/doc/manpage/ecryptfs.7 2008-07-06 21:44:46.000000000 -0500 +++ b/doc/manpage/ecryptfs.7 2008-07-23 15:23:59.493148596 -0500 @@ -0,0 +1,82 @@ +.TH ecryptfs 7 2008-07-21 ecryptfs-utils "eCryptfs" +.SH NAME +eCryptfs \- an enterprise-class cryptographic filesystem for linux + +.SH SYNOPSIS +.BI "mount -t ecryptfs [SRC DIR] [DST DIR] -o [OPTIONS]" + +.SH DESCRIPTION +eCryptfs is a POSIX-compliant enterprise-class stacked cryptographic filesystem for Linux. It is derived from Erez Zadok's Cryptfs, implemented through the FiST framework for generating stacked filesystems. eCryptfs extends Cryptfs to provide advanced key management and policy features. eCryptfs stores cryptographic metadata in the header of each file written, so that encrypted files can be copied between hosts; the file will be decryptable with the proper key, and there is no need to keep track of any additional information aside from what is already in the encrypted file itself. Think of eCryptfs as a sort of "gnupgfs." + +.SH OPTIONS + +STANDARD OPTIONS +.TP +.B key=(keytype):[Key Options] +Specify the type of key to be used when mounting eCryptfs. +.TP +.B ecryptfs_cipher=(cipher) +Specify the symmetric cipher to be used on a per file basis +.TP +.B ecryptfs_key_bytes=(key_bytes) +Specify the keysize to be used with the selected cipher. If the cipher only has one keysize the keysize does not need to be specified. +.TP +.B ecryptfs_passthrough +Allows for non-eCryptfs files to be read and written from within an eCryptfs mount. This option is turned off by default. +.TP +.B no_sig_cache +Do not check the mount key signature against the values in the user's ~/.ecryptfs/sig-cache.txt file. This is useful for such things as non-interactive setup scripts, so that the mount helper does not stop and prompt the user in the event that the key sig is not in the cache. +.TP +.B ecryptfs_encrypted_view +This option, when set, will have eCryptfs return the encrypted versions of the lower files, rather than decrypt encrypted files and return the decrypted data from the lower files. This options is useful for such things as backup utilities. +.TP +.B ecryptfs_xattr +Store the metadata in the extended attribute of the lower files rather than the header region of the lower files. +.TP +.B verbosity=(level) +Set to '1' in order to get verbose output from the kernel module. As a word of caution, this will cause secret values to be written in the clear to the system log, so this options should only be used for debugging purposes. +.TP + +KEY OPTIONS + +.TP +.B passwd=(passphrase) +The actual password is password. Since the password is visible to utilities (like ps under Unix) this form should only be used where security is not important. +.TP +.B passwd_file=(filename) +The password should be specified in a file with passwd=(passphrase). It is highly reccomended that the file be stored on a secure medium such as a personal usb key. +.TP +.B passwd_fd=(file descriptor) +The password is specified through the specified file descriptor. +.TP +.B passstdin +The user types their passphrase in through stdin. +.TP +.B salt=(hex value) +The salt should be specified as a 16 digit hex value. +.TP +.B keyfile=(filename) +The filename should be the filename of a file containing an RSA SSL key. + +.SH SEE ALSO +.PD 0 +.TP +\fBmount\fP(8) + +.TP +\fI/usr/share/doc/ecryptfs-utils/ecryptfs-faq.html\fP + +.TP +\fIhttp://ecryptfs.sourceforge.net/\fP +.PD + +.SH NOTES +Do not run eCryptfs in higher verbosity levels unless you are doing so for the sole purpose of development, since secret values will be written out to the system log in that case. + +.SH BUGS +Please send bug reports to the lead developer, an eCryptfs mailing list hosted from SourceForge, or to the SourceForge bug tracker for the eCryptfs project. For kernel bugs, please follow the procedure detailed in Documentation/oops-tracing.txt to help us figure out what is happening. + +.SH AUTHOR +This manpage was (re-)written by Dustin Kirkland <[EMAIL PROTECTED]> for Ubuntu systems (but may be used by others). Permission is granted to copy, distribute and/or modify this document under the terms of the GNU General Public License, Version 2 or any later version published by the Free Software Foundation. + +On Debian systems, the complete text of the GNU General Public License can be found in /usr/share/common-licenses/GPL. --- a/doc/manpage/ecryptfs.pod 2008-07-23 15:31:27.329142155 -0500 +++ b/doc/manpage/ecryptfs.pod 2008-07-06 21:44:46.000000000 -0500 @@ -1,127 +0,0 @@ - -=pod - -=head1 NAME - -eCryptfs - an enterprise-class cryptographic filesystem for linux - -=head1 SYNOPSIS - -B<mount -t ecryptfs> -[I<SRC DIR>] -[I<DST DIR>] -B<-o> -[I<OPTIONS>] - -=head1 DESCRIPTION - -eCryptfs is a POSIX-compliant enterprise-class stacked cryptographic -filesystem for Linux. It is derived from Erez Zadok's Cryptfs, implemented -through the FiST framework for generating stacked filesystems. eCryptfs -extends Cryptfs to provide advanced key management and policy features. -eCryptfs stores cryptographic metadata in the header of each file written, -so that encrypted files can be copied between hosts; the file will be -decryptable with the proper key, and there is no need to keep track of any -additional information aside from what is already in the encrypted file -itself. Think of eCryptfs as a sort of "gnupgfs." - -=head1 OPTIONS - -=head2 STANDARD OPTIONS - -=over 10 - -=item B<key=(keytype):[Key Options]> - -Specify the type of key to be used when mounting eCryptfs. - -=item B<ecryptfs_cipher=(cipher)> - -Specify the symmetric cipher to be used on a per file basis - -=item B<ecryptfs_key_bytes=(key_bytes)> - -Specify the keysize to be used with the selected cipher. If the cipher -only has one keysize the keysize does not need to be specified. - -=item B<ecryptfs_passthrough> - -Allows for non-eCryptfs files to be read and written from within an -eCryptfs mount. This option is turned off by default. - -=item B<no_sig_cache> - -Do not check the mount key signature against the values in the user's -~/.ecryptfs/sig-cache.txt file. This is useful for such things as -non-interactive setup scripts, so that the mount helper does not stop -and prompt the user in the event that the key sig is not in the cache. - -=item B<ecryptfs_encrypted_view> - -This option, when set, will have eCryptfs return the encrypted -versions of the lower files, rather than decrypt encrypted files and -return the decrypted data from the lower files. This options is useful -for such things as backup utilities. - -=item B<ecryptfs_xattr> - -Store the metadata in the extended attribute of the lower files rather -than the header region of the lower files. - -=item B<verbosity=(level)> - -Set to '1' in order to get verbose output from the kernel module. As a -word of caution, this will cause secret values to be written in the -clear to the system log, so this options should only be used for -debugging purposes. - -=head2 KEY OPTIONS - -=item B<passwd=(passphrase)> - -The actual password is password. Since the password is visible to utilities -(like 'ps' under Unix) this form should only be used where security is not -important. - -=item B<passwd_file=(filename)> - -The password should be specified in a file with B<passwd=(passphrase)>. It is -highly reccomended that the file be stored on a secure medium such as a -personal usb key. - -=item B<passwd_fd=(file descriptor)> - -The password is specified through the specified file descriptor. - -=item B<passstdin> - -The user types their passphrase in through stdin. - -=item B<salt=(hex value)> - -The salt should be specified as a 16 digit hex value. - -=item B<keyfile=(filename)> - -The filename should be the filename of a file containing an RSA SSL key. - -=head1 SEE ALSO - -L<mount(8)|mount(8)> - -=head1 NOTES - -Do not run eCryptfs in higher verbosity levels -unless you are doing so for the sole purpose of development, since -secret values will be written out to the system log in that case. - -=head1 BUGS - -Please send bug reports to the lead developer, an eCryptfs mailing -list hosted from SourceForge, or to the SourceForge bug tracker for -the eCryptfs project. For kernel bugs, please follow the procedure -detailed in Documentation/oops-tracing.txt to help us figure out what -is happening. - - -=cut
signature.asc
Description: This is a digitally signed message part
------------------------------------------------------------------------- This SF.Net email is sponsored by the Moblin Your Move Developer's challenge Build the coolest Linux based applications with Moblin SDK & win great prizes Grand prize is a trip for two to an Open Source event anywhere in the world http://moblin-contest.org/redirect.php?banner_id=100&url=/
_______________________________________________ eCryptfs-devel mailing list eCryptfs-devel@lists.sourceforge.net https://lists.sourceforge.net/lists/listinfo/ecryptfs-devel
