changelog shortlog tags branches files raw gz bz2 help

Mercurial > hg > ventivac / changeset: fix formatting, very visible in man2html output.

changeset 150: f041fd652c81
parent 149: da8fa3932d50
child 151: 2dd3d57a4d07
author: Mechiel Lukkien <mechiel@ueber.net>
date: Thu, 30 Aug 2007 19:34:34 +0200
files: man/2/vac
description: fix formatting, very visible in man2html output.
     1.1--- a/man/2/vac	Thu Aug 30 19:18:55 2007 +0200
     1.2+++ b/man/2/vac	Thu Aug 30 19:34:34 2007 +0200
     1.3@@ -79,7 +79,8 @@
     1.4 initialises the module and must be called before any other function.
     1.5 Adt's
     1.6 .IR Source ,
     1.7-.IR Vacfile and
     1.8+.I Vacfile
     1.9+and
    1.10 .I Vacdir
    1.11 provide functions for reading venti archives, along with
    1.12 .B openroot
    1.13@@ -87,7 +88,8 @@
    1.14 .BR readscore .
    1.15 Adt's
    1.16 .IR File ,
    1.17-.IR Sink and
    1.18+.I Sink
    1.19+and
    1.20 .I MSink 
    1.21 facilitate writing archives.
    1.22 .PP
    1.23@@ -137,7 +139,7 @@
    1.24 .B Venti->Session
    1.25 associated with it.
    1.26 .TP
    1.27-.BI s .new(\fIsession\fP,\ \fIentry\fP)
    1.28+.IB s .new(\fIsession\fP,\ \fIentry\fP)
    1.29 Create a new
    1.30 .B Source
    1.31 from the
    1.32@@ -146,7 +148,7 @@
    1.33 .IR Entry .
    1.34 Always succeeds.
    1.35 .TP
    1.36-.BI s .get(\fIindex\fP,\ \fIdata\fP)
    1.37+.IB s .get(\fIindex\fP,\ \fIdata\fP)
    1.38 Read a block from the hash tree into buffer
    1.39 .IR data .
    1.40 .I Index
    1.41@@ -155,7 +157,7 @@
    1.42 .I Entryvarblocks
    1.43 bit set.
    1.44 .TP
    1.45-.BI s .oget(\fIoffset\fP)
    1.46+.IB s .oget(\fIoffset\fP)
    1.47 Read a block from the hash tree starting at
    1.48 .I offset .
    1.49 The data returned has been zero-extended.
    1.50@@ -177,9 +179,9 @@
    1.51 A
    1.52 .B Vacfile
    1.53 can be created by
    1.54-.BI Vacfile.mk(\fIsource\fP)
    1.55+.IB Vacfile.mk(\fIsource\fP)
    1.56 and
    1.57-.BI Vacfile.new(\fIsession\fP,\ \fIentry\fP) .
    1.58+.IB Vacfile.new(\fIsession\fP,\ \fIentry\fP) .
    1.59 These functions always succeed.
    1.60 
    1.61 .PP
    1.62@@ -187,14 +189,14 @@
    1.63 represents a directory stored in a venti archive.  A venti directory is stored in Venti as two hash trees: one containing Entries representing the (data) contents of files and one containing all meta-information (direntries) for those files.  A file in a directory is represented as a
    1.64 .IR Direntry .
    1.65 .TP
    1.66-.BI vd .mk(\fIvacfile\fP,\ \fImetasource\fP)
    1.67+.IB vd .mk(\fIvacfile\fP,\ \fImetasource\fP)
    1.68 Open a venti directory.
    1.69 .I Vacfile
    1.70 should contain Entries,
    1.71 .I metasource
    1.72 should contain Direntries.
    1.73 .TP
    1.74-.BI vd .new(\fIsession\fP,\ \fIentry\fP,\ \fImetaentry\fP)
    1.75+.IB vd .new(\fIsession\fP,\ \fIentry\fP,\ \fImetaentry\fP)
    1.76 Open a venti directory from a
    1.77 .I entry
    1.78 and
    1.79@@ -202,7 +204,7 @@
    1.80 such as those as returned by 
    1.81 .IR Vacdir.open .
    1.82 .TP
    1.83-.BI vd .walk(\fIelem\fP)
    1.84+.IB vd .walk(\fIelem\fP)
    1.85 Return the
    1.86 .B Direntry
    1.87 representing the file
    1.88@@ -210,7 +212,7 @@
    1.89 .B Nil
    1.90 is returned when the file does not exist and the system error string set.
    1.91 .TP
    1.92-.BI vd .open(\fIdirentry\fP)
    1.93+.IB vd .open(\fIdirentry\fP)
    1.94 `Open' the file represented by
    1.95 .IR direntry ,
    1.96 by returning its
    1.97@@ -221,11 +223,11 @@
    1.98 non-nil
    1.99 for directories.
   1.100 .TP
   1.101-.BI vd .readdir()
   1.102+.IB vd .readdir()
   1.103 Read files in a directory.  The number of direntries returned depends on the block size of the underlying archive.
   1.104 The first element of the tuple has the number of direntries returned and is < 0 for errors, and 0 when all files have been returned.  
   1.105 .TP
   1.106-.BI vd .rewind()
   1.107+.IB vd .rewind()
   1.108 Rewind the directory offset to 0.  Subsequent reads again return files.
   1.109 
   1.110 .PP
   1.111@@ -250,7 +252,7 @@
   1.112 .I dsize
   1.113 has no meaning for the data block size and is only used for the pointer block size.
   1.114 .TP
   1.115-.BI f .write(\fIdata\fP)
   1.116+.IB f .write(\fIdata\fP)
   1.117 Write
   1.118 .I data
   1.119 to the hash tree.
   1.120@@ -258,12 +260,12 @@
   1.121 On failure -1 is returned, on success 0 is returned.
   1.122 Pointer blocks that have filled up by this write are flushed as well.
   1.123 .TP
   1.124-.BI f .finish()
   1.125+.IB f .finish()
   1.126 Flush all remaining pointer blocks and the top-level
   1.127-.B Entry to Venti and return the
   1.128-.B Entry.
   1.129+.B Entry
   1.130+to Venti and return the entry.
   1.131 .TP
   1.132-.BI f .mkstate(\fIsession\fP,\ \fIentry\fP,\ \fIvarblocks\fP)
   1.133+.IB f .mkstate(\fIsession\fP,\ \fIentry\fP,\ \fIvarblocks\fP)
   1.134 Initialise a
   1.135 .B File
   1.136 from an existing
   1.137@@ -286,15 +288,15 @@
   1.138 .B File
   1.139 when a data block has been filled with entries.
   1.140 .TP
   1.141-.BI s .new(\fIsession\fP,\ \fIdsize\fP)
   1.142+.IB s .new(\fIsession\fP,\ \fIdsize\fP)
   1.143 Make a new, empty directory.  The size of the blocks in which entries are stored is
   1.144 .IR dsize .
   1.145 .TP
   1.146-.BI s .add(\fIentry\fP)
   1.147+.IB s .add(\fIentry\fP)
   1.148 Add an entry to the directory.
   1.149 If a block is filled, it is flushed to Venti.
   1.150 .TP
   1.151-.BI s .finish()
   1.152+.IB s .finish()
   1.153 Flush the underlying file and return the
   1.154 .B Entry
   1.155 representing the directory.
   1.156@@ -323,7 +325,8 @@
   1.157 The variables
   1.158 .IR blocksread ,
   1.159 .IR blockswritten ,
   1.160-.IR bytesread and
   1.161+.I bytesread
   1.162+and
   1.163 .I byteswritten
   1.164 are kept up to date during module use.
   1.165 They contain the total number of blocks and bytes read from and
   1.166@@ -347,7 +350,7 @@
   1.167 .B Root
   1.168 block.
   1.169 The tuple returned contains the 
   1.170-.BI Vacdir ,
   1.171+.BR Vacdir ,
   1.172 and the
   1.173 .B Direntry
   1.174 containing information about the root directory.  The third element describes an error if it is not
   1.175@@ -358,4 +361,3 @@
   1.176 .IR venti (2)
   1.177 .SH DIAGNOSTICS
   1.178 The functions unpacking data structures return nil for badly formed data, and set the system error string.
   1.179-.SH BUGS