~ubuntu-branches/debian/lenny/tdb/lenny

« back to all changes in this revision

Viewing changes to README

  • Committer: Bazaar Package Importer
  • Author(s): Marek Habersack
  • Date: 2005-05-04 11:11:22 UTC
  • mfrom: (2.1.1 hoary)
  • Revision ID: james.westby@ubuntu.com-20050504111122-7vpgb6zbq9zzc34t
Tags: 1.0.6-13
* Closes: #307214: ctrlproxy: FTBFS: /usr/include/tdb.h:150: error:
  parse error before '*' token
* Thanks to Wilmer van der Gaast <lintux@debian.org> for providing
  the patch to fix the above issue.
* Closes: #290211: Improper copyright file
* Closes: #262490: tdb_1.0.6-8_mips: FTBFS: opcode not supported on
  this processor: mips1. Spinlocks are not used on mips.

Show diffs side-by-side

added added

removed removed

Lines of Context:
31
31
tdbtest and tdbtool are not built as part of Samba, but are included
32
32
for completeness.
33
33
 
34
 
 
35
 
File formats
36
 
------------
37
 
append tdb.magic to your /etc/magic so that file will recognise tdb
38
 
files.
39
 
 
40
 
 
41
34
Interface
42
35
---------
43
36
 
75
68
                   memory. The filename is ignored in this case.
76
69
    TDB_NOLOCK - don't do any locking
77
70
    TDB_NOMMAP - don't use mmap
78
 
    TDB_CONVERT - Create a database in the reverse of native endian:
79
 
                  normally when the database is created (or cleared
80
 
                  with TDB_CLEAR_IF_FIRST), it is created in native
81
 
                  endian order. This flag is set (or unset) 
82
 
                  automat ically for existing databases.
83
 
 
84
 
 
85
 
----------------------------------------------------------------------
86
 
enum TDB_ERROR tdb_error(TDB_CONTEXT *tdb);
87
 
 
88
 
   tdb_error returns the current error state of the tdb database.
89
 
 
90
 
----------------------------------------------------------------------
91
 
const char *tdb_errorstr(TDB_CONTEXT *tdb);
92
 
 
93
 
   tdb_errorstr returns a printable string that describes the
94
 
   error state of the database.
 
71
 
 
72
----------------------------------------------------------------------
 
73
char *tdb_error(TDB_CONTEXT *tdb);
 
74
 
 
75
     return a error string for the last tdb error
95
76
 
96
77
----------------------------------------------------------------------
97
78
int tdb_close(TDB_CONTEXT *tdb);
166
147
   return 0 on success, -1 on failure
167
148
 
168
149
----------------------------------------------------------------------
169
 
int tdb_lockall(TDB_CONTEXT *tdb);
 
150
int tdb_writelock(TDB_CONTEXT *tdb);
170
151
 
171
152
   lock the database. If we already have it locked then don't do anything
172
153
 
173
154
----------------------------------------------------------------------
174
 
int tdb_unlockall(TDB_CONTEXT *tdb);
 
155
int tdb_writeunlock(TDB_CONTEXT *tdb);
175
156
   unlock the database
176
157
 
177
158
----------------------------------------------------------------------