1<?xml version="1.0" encoding="UTF-8" standalone="no"?> 2<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> 3<html xmlns="http://www.w3.org/1999/xhtml"> 4 <head> 5 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /> 6 <title>berkdb envremove</title> 7 <link rel="stylesheet" href="apiReference.css" type="text/css" /> 8 <meta name="generator" content="DocBook XSL Stylesheets V1.73.2" /> 9 <link rel="start" href="index.html" title="Berkeley DB TCL API Reference" /> 10 <link rel="up" href="tclapi.html" title="Chapter 1. Berkeley DB Tcl APIs" /> 11 <link rel="prev" href="env_open.html" title="berkdb env" /> 12 <link rel="next" href="txn.html" title="env txn" /> 13 </head> 14 <body> 15 <div class="navheader"> 16 <table width="100%" summary="Navigation header"> 17 <tr> 18 <th colspan="3" align="center">berkdb envremove</th> 19 </tr> 20 <tr> 21 <td width="20%" align="left"><a accesskey="p" href="env_open.html">Prev</a> </td> 22 <th width="60%" align="center">Chapter 1. 23 Berkeley DB Tcl APIs 24 </th> 25 <td width="20%" align="right"> <a accesskey="n" href="txn.html">Next</a></td> 26 </tr> 27 </table> 28 <hr /> 29 </div> 30 <div class="sect1" lang="en" xml:lang="en"> 31 <div class="titlepage"> 32 <div> 33 <div> 34 <h2 class="title" style="clear: both"><a id="env_remove"></a>berkdb envremove</h2> 35 </div> 36 </div> 37 </div> 38 <pre class="programlisting">berkdb envremove 39 [-data_dir directory] 40 [-force] 41 [-home directory] 42 [-log_dir directory] 43 [-tmp_dir directory] 44 [-use_environ] 45 [-use_environ_root] </pre> 46 <p> 47 Remove a Berkeley DB environment. 48 </p> 49 <p> 50 The options are as follows: 51 </p> 52 <div class="itemizedlist"> 53 <ul type="disc"> 54 <li> 55 <p> 56 <span class="bold"><strong>-data_dir dirname</strong></span> 57 </p> 58 <p> 59 Specify the environment's data directory, as described in 60 <a href="../../programmer_reference/env_naming.html" class="olink">Berkeley DB File Naming</a> 61 in the <em class="citetitle">Berkeley DB Programmer's Reference Guide</em>. 62 </p> 63 </li> 64 <li> 65 <p> 66 <span class="bold"><strong>-force</strong></span> 67 </p> 68 <p> 69 If there are processes that have called <span class="bold"><strong>berkdb 70 env</strong></span> without calling <span class="emphasis"><em>env</em></span> <span class="bold"><strong>close</strong></span> (that is, there are processes currently 71 using the environment), <span class="bold"><strong>berkdb 72 envremove</strong></span> will fail without further action, unless the 73 <span class="bold"><strong>-force</strong></span> flag is set, in which case 74 <span class="bold"><strong>berkdb envremove</strong></span> will attempt to 75 remove the environment regardless of any processes still using it. 76 </p> 77 </li> 78 <li> 79 <p> 80 <span class="bold"><strong>-home directory</strong></span> 81 </p> 82 <p> 83 The <span class="bold"><strong>-home</strong></span> argument is described in 84 <a href="../../programmer_reference/env_naming.html" class="olink">Berkeley DB File Naming</a> 85 in the <em class="citetitle">Berkeley DB Programmer's Reference Guide</em>. 86 </p> 87 </li> 88 <li> 89 <p> 90 <span class="bold"><strong>-log_dir dirname</strong></span> 91 </p> 92 <p> 93 Specify the environment's log directory, as described in 94 <a href="../../programmer_reference/env_naming.html" class="olink">Berkeley DB File Naming</a> 95 in the <em class="citetitle">Berkeley DB Programmer's Reference Guide</em>. 96 </p> 97 </li> 98 <li> 99 <p> 100 <span class="bold"><strong>-tmp_dir dirname</strong></span> 101 </p> 102 <p> 103 Specify the environment's tmp directory, as described in 104 <a href="../../programmer_reference/env_naming.html" class="olink">Berkeley DB File Naming</a> 105 in the <em class="citetitle">Berkeley DB Programmer's Reference Guide</em>. 106 </p> 107 </li> 108 <li> 109 <p> 110 <span class="bold"><strong>-use_environ</strong></span> 111 </p> 112 <p> 113 The Berkeley DB process' environment may be permitted to specify 114 information to be used when naming files; see 115 <a href="../../programmer_reference/env_naming.html" class="olink">Berkeley DB File Naming</a> 116 in the <em class="citetitle">Berkeley DB Programmer's Reference Guide</em>. 117 Because permitting users to specify which files are used can create security 118 problems, environment information will be used in file naming for all 119 users only if the <span class="bold"><strong>-use_environ</strong></span> flag 120 is set. 121 </p> 122 </li> 123 <li> 124 <p> 125 <span class="bold"><strong>-use_environ_root</strong></span> 126 </p> 127 <p> 128 The Berkeley DB process' environment may be permitted to specify 129 information to be used when naming files; see 130 <a href="../../programmer_reference/env_naming.html" class="olink">Berkeley DB File Naming</a> 131 in the <em class="citetitle">Berkeley DB Programmer's Reference Guide</em>. 132 As permitting users to specify which files are used can create security 133 problems, if the <span class="bold"><strong>-use_environ_root</strong></span> 134 flag is set, environment information will be used for file naming only 135 for users with appropriate permissions (for example, users with a 136 user-ID of 0 on IEEE/ANSI Std 1003.1 (POSIX) systems). 137 </p> 138 </li> 139 </ul> 140 </div> 141 <p> 142 The <span class="bold"><strong>berkdb envremove</strong></span> command returns 143 0 on success, and in the case of error, a Tcl error is thrown. 144 </p> 145 </div> 146 <div class="navfooter"> 147 <hr /> 148 <table width="100%" summary="Navigation footer"> 149 <tr> 150 <td width="40%" align="left"><a accesskey="p" href="env_open.html">Prev</a> </td> 151 <td width="20%" align="center"> 152 <a accesskey="u" href="tclapi.html">Up</a> 153 </td> 154 <td width="40%" align="right"> <a accesskey="n" href="txn.html">Next</a></td> 155 </tr> 156 <tr> 157 <td width="40%" align="left" valign="top">berkdb env </td> 158 <td width="20%" align="center"> 159 <a accesskey="h" href="index.html">Home</a> 160 </td> 161 <td width="40%" align="right" valign="top"> <span class="emphasis"><em>env</em></span> txn</td> 162 </tr> 163 </table> 164 </div> 165 </body> 166</html> 167