mc/vfs
Enrico Weigelt, metux IT service 183a66f7f5 changing return types of *read() and *write() functions to ssize_t 2009-01-13 19:00:25 +01:00
..
extfs fixed some bashisms in vfs/extfs/* 2009-01-12 20:58:50 +01:00
samba Removed .cvsignore files as we don't need them any longer 2009-01-05 16:58:44 +01:00
.gitignore Added .svnignore files (same as .cvsignore) 2008-12-28 23:27:03 +02:00
COPYING.LGPL Update postal address of Free Software Foundation. 2005-05-27 03:35:10 +00:00
ChangeLog * vfs/fish.c (fish_dir_load): Check the exit status of the remote command 2007-11-02 14:50:41 +00:00
HACKING Initial version of technical documentation for VFS. 2003-10-30 05:52:35 +00:00
Makefile.am * Makefile.am: Add fish.h. 2006-02-23 16:00:13 +00:00
README * README: Add explanation for using GPL licensed code from 2004-10-23 12:32:21 +00:00
README.fish Typos. 2003-06-02 19:47:30 +00:00
cpio.c changing return types of *read() and *write() functions to ssize_t 2009-01-13 19:00:25 +01:00
direntry.c changing return types of *read() and *write() functions to ssize_t 2009-01-13 19:00:25 +01:00
extfs.c changing return types of *read() and *write() functions to ssize_t 2009-01-13 19:00:25 +01:00
fish.c * vfs/fish.c (fish_dir_load): Check the exit status of the remote command 2007-11-02 14:50:41 +00:00
fish.h * vfs/fish.h: New file. 2006-02-23 15:32:18 +00:00
ftpfs.c * edit/bookmark.c: Update copyright notice. 2007-09-25 15:33:35 +00:00
ftpfs.h * src/boxes.c, vfs/ftpfs.[ch]: Add checkbox to allow passive FTP 2005-05-29 12:10:08 +00:00
gc.c * edit/bookmark.c: Update copyright notice. 2007-09-25 15:33:35 +00:00
gc.h * *.h: Renamed the multiple inclusion guards. 2005-02-18 21:15:37 +00:00
local.c changing return types of *read() and *write() functions to ssize_t 2009-01-13 19:00:25 +01:00
local.h changing return types of *read() and *write() functions to ssize_t 2009-01-13 19:00:25 +01:00
mcfs.c changing return types of *read() and *write() functions to ssize_t 2009-01-13 19:00:25 +01:00
mcfs.h * *.h: Renamed the multiple inclusion guards. 2005-02-18 21:15:37 +00:00
mcfsutil.c Update postal address of Free Software Foundation. 2005-05-27 03:35:10 +00:00
mcfsutil.h * *.h: Renamed the multiple inclusion guards. 2005-02-18 21:15:37 +00:00
mcserv.c * edit/bookmark.c: Update copyright notice. 2007-09-25 15:33:35 +00:00
sfs.c * src/achown.c: Update copyright notice. 2007-09-26 10:22:25 +00:00
smbfs.c changing return types of *read() and *write() functions to ssize_t 2009-01-13 19:00:25 +01:00
smbfs.h * *.h: Renamed the multiple inclusion guards. 2005-02-18 21:15:37 +00:00
tar.c changing return types of *read() and *write() functions to ssize_t 2009-01-13 19:00:25 +01:00
tcputil.c * src/achown.c: Update copyright notice. 2007-09-26 10:22:25 +00:00
tcputil.h * *.h: Renamed the multiple inclusion guards. 2005-02-18 21:15:37 +00:00
undelfs.c changing return types of *read() and *write() functions to ssize_t 2009-01-13 19:00:25 +01:00
utilvfs.c * edit/bookmark.c: Update copyright notice. 2007-09-25 15:33:35 +00:00
utilvfs.h * utilvfs.h (vfs_parse_filetype, vfs_parse_fileperms, 2005-09-26 11:10:24 +00:00
vfs-impl.h changing return types of *read() and *write() functions to ssize_t 2009-01-13 19:00:25 +01:00
vfs.c * edit/bookmark.c: Update copyright notice. 2007-09-25 15:33:35 +00:00
vfs.h changing return types of *read() and *write() functions to ssize_t 2009-01-13 19:00:25 +01:00
xdirentry.h fish.c, xdirentry.h: Fix 2 GB file size limit for fish. 2006-01-27 22:16:45 +00:00

README

NOTE: Although vfs has been meant to be implemented as a separate
entity redistributable under the LGPL in its current implementation it
uses GPLed code from src/. So there are two possibilities if you want
to use vfs:

1. Distribute your copy of vfs under the GPL. Then you can freely
include the GPLed functions from the rest of the mc source code.

2. Distribute your copy of vfs under the LGPL. Then you cannot include
the functions outside the vfs subdirectory. You must then either
rewrite them or work around them in other ways.

========================================================================

Hi!

I'm midnight commander's vfs layer. Before you start hacking me,
please read this file. I'm integral part of midnight commander, but I
try to go out and live my life myself as a shared library, too. That
means that I should try to use as little functions from midnight as
possible (so I'm tiny, nice and people like me), that I should not
pollute name space by unnecessary symbols (so I do not crash fellow
programs) and that I should have a clean interface between myself and
midnight.

Because I'm rather close to midnight, try to:

* Keep updating ChangeLog file.

* Keep the indentation as the rest of the code. Following could help
you with your friend emacs:

(defun mc-c-mode ()
	"C mode with adjusted defaults for use with the Midnight commander."
	(interactive)
	(c-mode)
	(c-set-style "K&R")
	(setq	c-indent-level 4
		c-continued-statement-offset 4
		c-brace-offset 0
		c-argdecl-indent 4
		c-label-offset -4
		c-brace-imaginary-offset 0
		c-continued-brace-offset 0
		c-tab-always-indent nil
		c-basic-offset 4
		tab-width 8
		comment-column 60))

(setq auto-mode-alist (cons '(".*/mc/.*\\.[ch]$" . mc-c-mode)
                       auto-mode-alist))

And because I'm trying to live life on my own as libvfs.so, try to:

* Make sure all exported symbols are defined in vfs.h and begin with
'vfs_'.

* Do not make any references from midnight into modules like tar. It
would probably pollute name space and midnight would depend on concrete
configuration of libvfs. mc_setctl() and mc_ctl() are your
friends. (And mine too :-).

							 Pavel Machek
							 pavel@ucw.cz

PS: If you'd like to use my features in whole operating system, you
might want to link me to rpc.nfsd. On
http://atrey.karlin.mff.cuni.cz/~pavel/podfuk/podfuk.html you'll find
how to do it.

PPS: I have a friend, shared library called avfs, which is LD_PRELOAD
capable. You can reach her at http://www.inf.bme.hu/~mszeredi/avfs.