vfs/README

   1 Hi!
   2
   3 I'm midnight commander's vfs layer. Before you start hacking me,
   4 please read this file. I'm integral part of midnight commander, but I
   5 try to go out and live my life myself as a shared library, too. That
   6 means that I should try to use as little functions from midnight as
   7 possible (so I'm tiny, nice and people like me), that I should not
   8 pollute name space by unnecessary symbols (so I do not crash fellow
   9 programs) and that I should have a clean interface between myself and
  10 midnight.
  11
  12 Because I'm rather close to midnight, try to:
  13
  14 * Keep updating ChangeLog file.
  15
  16 * Keep the indentation as the rest of the code. Following could help
  17 you with your friend emacs:
  18
  19 (defun mc-c-mode ()
  20         "C mode with adjusted defaults for use with the Midnight commander."
  21         (interactive)
  22         (c-mode)
  23         (c-set-style "K&R")
  24         (setq   c-indent-level 4
  25                 c-continued-statement-offset 4
  26                 c-brace-offset 0
  27                 c-argdecl-indent 4
  28                 c-label-offset -4
  29                 c-brace-imaginary-offset 0
  30                 c-continued-brace-offset 0
  31                 c-tab-always-indent nil
  32                 c-basic-offset 4
  33                 tab-width 8
  34                 comment-column 60))
  35
  36 (setq auto-mode-alist (cons '(".*/mc/.*\\.[ch]$" . mc-c-mode)
  37                        auto-mode-alist))
  38
  39 And because I'm trying to live life on my own as libvfs.so, try to:
  40
  41 * Make sure all exported symbols are defined in vfs.h and begin with
  42 'vfs_'.
  43
  44 * Do not make any references from midnight into modules like tar. It
  45 would probably pollute name space and midnight would depend on concrete
  46 configuration of libvfs. mc_setctl() and mc_ctl() are your
  47 friends. (And mine too :-).
  48
  49                                                          Pavel Machek
  50                                                          pavel@ucw.cz
  51
  52 PS: If you'd like to use my features in whole operating system, you
  53 might want to link me to rpc.nfsd. On
  54 http://atrey.karlin.mff.cuni.cz/~pavel/podfuk/podfuk.html you'll find
  55 how to do it.
  56
  57 PPS: I have a friend, shared library called avfs, which is LD_PRELOAD
  58 capable. You can reach her at http://www.inf.bme.hu/~mszeredi/avfs.