/usr/share/slsh/local-packages/help/gdbm.hlp is in slang-gdbm 1.7.1-4.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 | gdbm_open
SYNOPSIS
open a gdbm database
USAGE
GDBM_Type gdbm_open(String_Type file, Int_Type flags, Int_Type mode)
DESCRIPTION
The `gdbm_open' function opens a GDBM file and returns a GDBM_Type
object. On failure it returns NULL and sets `gdbm_errno'.
The flags are GDBM_READER for opening read-only, GDBM_WRITER for a
reader/writer, and GDBM_WRCREAT for creating the file if it does not
exist. There are other flags as well, see the info documentation for
gdbm. The mode specifies the file permissions of a newly created file.
NOTES
Only one application at a time can open a dbf for writing. A dbf can
be opened by many readers, but not if it is opened for writing.
SEE ALSO
gdbm_close, gdbm_store, gdbm_fetch, gdbm_exists, gdbm_delete
--------------------------------------------------------------
gdbm_close
SYNOPSIS
close a gdbm database
USAGE
gdbm_close(GDBM_Type dbf)
DESCRIPTION
closes a gdbm database.
NOTES
The database is also automatically closed when the `dbf' variable
goes out of scope.
--------------------------------------------------------------
gdbm_store
SYNOPSIS
stores a key/value pair in a GDBM dbf
USAGE
Int_Type gdbm_store(GDBM_Type dbf, String_Type key, String_Type val, Int_Type flags)
DESCRIPTION
Inserts or replaces records in the database. If the flag is GDBM_INSERT,
and the key is already in the database, it fails. If the flag is
GDBM_REPLACE, the old value is replaced. On success it returns 0.
NOTES
You can also write `dbf[key] = value;'
This implies GDBM_REPLACE.
SEE ALSO
gdbm_delete, gdbm_fetch, gdbm_exists
--------------------------------------------------------------
gdbm_fetch
SYNOPSIS
fetch a value from a gdbm database
USAGE
String_Type gdbm_fetch(GDBM_Type dbf, String_Type key)
DESCRIPTION
Gets the value of the entry with key `key' from the GDBM file `dbf'.
If the key does not exist it returns NULL.
NOTES
You can also fetch the value with the expression `dbf[key]'
SEE ALSO
gdbm_exists
--------------------------------------------------------------
gdbm_exists
SYNOPSIS
test if a value is present in a database
USAGE
Integer_Type gdbm_exists(GDBM_Type dbf, String_Type key)
DESCRIPTION
If the `key' exists in the database `dbf', it returns 1.
Otherwise 0.
--------------------------------------------------------------
gdbm_delete
SYNOPSIS
delete a record from a GDBM database
USAGE
Integer_Type gdbm_delete(GDBM_Type dbf, String_Type key)
DESCRIPTION
`gdbm_delete' removes the keyed item and the `key' from the database
`dbf'.
The ret value is -1 if the item is not present or the requester is a
reader. The ret value is 0 if there was a successful delete.
--------------------------------------------------------------
gdbm_get_keys
SYNOPSIS
get all keys in a GDBM dbf
USAGE
String_Type[] gdbm_get_keys(GDBM_Type dbf)
DESCRIPTION
This function returns all the key names of `dbf' as an ordinary
one dimensional array of strings. If the `dbf' contains no records,
an empty array will be returned.
NOTES
It is also possible to iterate over a dbf's records with
`foreach (dbf) using (keys)' etc.
SEE ALSO
gdbm_get_values, gdbm_get_keys_and_values
--------------------------------------------------------------
gdbm_get_values
SYNOPSIS
get values from a gdbm
USAGE
String_Type[] gdbm_get_values(GDBM_Type)
DESCRIPTION
This function returns all the values in `dbf' as an ordinary
one dimensional array of strings. If the `dbf' contains no records,
an empty array will be returned.
SEE ALSO
gdbm_get_keys, gdbm_get_keys_and_values
--------------------------------------------------------------
gdbm_get_keys_and_values
SYNOPSIS
get keys and values from a gdbm
USAGE
(String_Typep[], String_Type[]) gdbm_get_keys_and_values(GDBM_Type)
DESCRIPTION
This function returns all the keys and values of `dbf' as two
arrays of strings. If the `dbf' contains no records, two empty arrays
will be returned.
SEE ALSO
gdbm_get_keys, gdbm_get_values
--------------------------------------------------------------
gdbm_error
SYNOPSIS
get the gdbm error string
USAGE
String_Type gdbm_error([Integer_Type code])
DESCRIPTION
converts the gdbm error code `code' into English text. Without arguments
it returns the error string of `gdbm_errno'.
SEE ALSO
gdbm_errno
--------------------------------------------------------------
gdbm_reorganize
SYNOPSIS
reorganize a gdbm
USAGE
Int_Type gdbm_reorganize(GDBM_Type)
DESCRIPTION
If you have had a lot of deletions and would like to shrink the space
used by the `gdbm' file, this function will reorganize the database.
If an error is detected, the return value is negative. The value zero is
returned after a successful reorganization.
--------------------------------------------------------------
gdbm_errno
SYNOPSIS
gdbm's error code
DESCRIPTION
When a gdbm functions fails it sets this variable to a non-zero value.
SEE ALSO
gdbm_error
--------------------------------------------------------------
|