Package: beaglefs Version: 1.0.3-1 Severity: normal Tags: patch
Hello, I wrote a man page for beaglefs (actually, most of the documentation was already written in the readme files ;) It should solve lintian's "beaglefs binary: binary-without-manpage" Franklin -- System Information: Debian Release: testing/unstable APT prefers testing APT policy: (990, 'testing') Architecture: i386 (i686) Shell: /bin/sh linked to /bin/bash Kernel: Linux 2.6.17-2-686 Locale: LANG=C, LC_CTYPE=C (charmap=ANSI_X3.4-1968) Versions of packages beaglefs depends on: ii fuse-utils 2.5.3-4.1 Filesystem in USErspace (utilities ii libbeagle0 0.2.10-1 library for accessing beagle (deve ii libc6 2.3.6.ds1-4 GNU C Library: Shared libraries ii libfuse2 2.5.3-4.1 Filesystem in USErspace library ii libglib2.0-0 2.12.4-1 The GLib library of C routines ii libxml2 2.6.26.dfsg-4 GNOME XML library beaglefs recommends no packages. -- no debconf information
.\" '\" t .\" ** The above line should force tbl to be a preprocessor ** .\" Man page for man .\" .\" Copyright (C), 2006, Franklin PIAT .\" heavely based on docuemntations from Robert Love .\" .\" You may distribute under the terms of the GNU General Public .\" License as specified in the file COPYING that comes with the .\" beaglefs distribution. .\" .\" Wed Nov 1 16:43:02 CET 2006 Franklin PIAT ([EMAIL PROTECTED]) .\" .\" .pc .TH "beaglefs" "1" "1.0" "Franklin PIAT" "User Commands" .SH "NAME" .LP beaglefs \- mount a filesystem representing a beagle query .SH "SYNOPSIS" .LP \fBbeaglefs\fR \fIquery\fR \fImountpoint\fR [\fIoptions\fR] .SH "DESCRIPTION" .LP beaglefs (it would be tomfs but Joey hates the name Tom) implements a filesystem representing a live Beagle query. The filesystem represents query hit results as symlinks to the hit targets. .LP In addition, beaglefs provides the following features: .IP "* Live updating" 4 The filesystem is updated on\-the\-fly as hits come and go. .IP "* Extended Attributes" 4 Beagle hit metadata is exported as extended attributes in the system.B eagle.* namespace. .IP "* Constant time operations" 4 The backing data structure is a hash table, providing O(1) best\-case complexity for many operations. .SH "OPTIONS" .LP .SS "general options:" .TP \fB\-o\fR opt,[opt...] mount options .TP \fB\-h\fR \fB\-\-help\fR print help .TP \fB\-V\fR \fB\-\-version\fR print version .SS "FUSE options:" .TP \fB\-d\fR \fB\-o\fR debug enable debug output (implies \fB\-f\fR) .TP \fB\-f\fR foreground operation .TP \fB\-s\fR disable multi\-threaded operation .TP \fB\-o\fR allow_other allow access to other users .TP \fB\-o\fR allow_root allow access to root .TP \fB\-o\fR nonempty allow mounts over non\-empty file/dir .HP \fB\-o\fR default_permissions enable permission checking by kernel .TP \fB\-o\fR fsname=NAME set filesystem name .TP \fB\-o\fR large_read issue large read requests (2.4 only) .TP \fB\-o\fR max_read=N set maximum size of read requests .TP \fB\-o\fR hard_remove immediate removal (don't hide files) .TP \fB\-o\fR use_ino let filesystem set inode numbers .TP \fB\-o\fR readdir_ino try to fill in d_ino in readdir .TP \fB\-o\fR direct_io use direct I/O .TP \fB\-o\fR kernel_cache cache files in kernel .TP \fB\-o\fR umask=M set file permissions (octal) .TP \fB\-o\fR uid=N set file owner .TP \fB\-o\fR gid=N set file group .TP \fB\-o\fR entry_timeout=T cache timeout for names (1.0s) .TP \fB\-o\fR negative_timeout=T cache timeout for deleted names (0.0s) .TP \fB\-o\fR attr_timeout=T cache timeout for attributes (1.0s) .PP .SH "EXAMPLES" .LP To mount a beagle query (search the string "Joey Shaw") : .PP .Vb 1 \& $ beaglefs "Joey Shaw" /home/rlove/joey .Ve .PP Then you can play a little bit : .PP .Vb 4 \& $ ls \-la /home/rlove/joey .br \& $ getfattr \-m "." \-h \-d /home/rlove/joey/joeys_cat.jpg .br \& $ stat /home/rlove/joey/joeys_cat.jpg .br \& $ stat \-f /home/rlove/joey .Ve .PP To unmount a previsously mounted point : .PP .Vb 1 \& $ fusermount \-u /home/rlove/joey .Ve .PP Alternatively, you can use /etc/fstab to declare a mountpoint: .Vb 2 \& #sample line to be added to /etc/fstab: .br \& beaglefs#Joey /home/fpiat/Wissant fuse user 0 0 .Ve .SH "LIMITATIONS" .LP Currently, the query is defined at mount time. .LP Supported file operations: readdir, readlink, getxattr, listxattr, stat, and statfs. .SH "AUTHORS" .LP This manpage was originally written by Franklin PIAT <[EMAIL PROTECTED]> for the Debian distribution of beaglefs. The main author of beaglefs is Robert Love <[EMAIL PROTECTED]>. .SH "SEE ALSO" .LP fusermount(1), beagle\-query(1)
