Debian Codegraph @

upstream/debian-unstable/man8/samba-regedit.8

raw
1 '\" t
2 .\" Title: samba-regedit
3 .\" Author: [see the "AUTHOR" section]
4 .\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
5 .\" Date: 05/26/2026
6 .\" Manual: System Administration tools
7 .\" Source: Samba 4.24.3-Debian-4.24.3+dfsg-1
8 .\" Language: English
9 .\"
10 .TH "SAMBA\-REGEDIT" "8" "05/26/2026" "Samba 4\&.24\&.3\-Debian\-4\&.24\&.3+dfs" "System Administration tools"
11 .\" -----------------------------------------------------------------
12 .\" * Define some portability stuff
13 .\" -----------------------------------------------------------------
14 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
15 .\" http://bugs.debian.org/507673
16 .\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
17 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
18 .ie \n(.g .ds Aq \(aq
19 .el .ds Aq '
20 .\" -----------------------------------------------------------------
21 .\" * set default formatting
22 .\" -----------------------------------------------------------------
23 .\" disable hyphenation
24 .nh
25 .\" disable justification (adjust text to left margin only)
26 .ad l
27 .\" -----------------------------------------------------------------
28 .\" * MAIN CONTENT STARTS HERE *
29 .\" -----------------------------------------------------------------
30 .SH "NAME"
31 samba-regedit \- ncurses based tool to manage the Samba registry
32 .SH "SYNOPSIS"
33 .HP \w'\ 'u
34 samba\-regedit [\-?|\-\-help] [\-\-usage] [\-d|\-\-debuglevel=DEBUGLEVEL] [\-\-debug\-stdout] [\-\-configfile=CONFIGFILE] [\-\-option=name=value] [\-l|\-\-log\-basename=LOGFILEBASE] [\-\-leak\-report] [\-\-leak\-report\-full] [\-R|\-\-name\-resolve=NAME\-RESOLVE\-ORDER] [\-O|\-\-socket\-options=SOCKETOPTIONS] [\-m|\-\-max\-protocol=MAXPROTOCOL] [\-n|\-\-netbiosname=NETBIOSNAME] [\-\-netbios\-scope=SCOPE] [\-W|\-\-workgroup=WORKGROUP] [\-\-realm=REALM] [\-U|\-\-user=[DOMAIN/]USERNAME[%PASSWORD]] [\-N|\-\-no\-pass] [\-\-password=STRING] [\-\-pw\-nt\-hash] [\-A|\-\-authentication\-file=FILE] [\-P|\-\-machine\-pass] [\-\-simple\-bind\-dn=DN] [\-\-use\-kerberos=desired|required|off] [\-\-use\-krb5\-ccache=CCACHE] [\-\-use\-winbind\-ccache] [\-\-client\-protection=sign|encrypt|off] [\-V|\-\-version]
35 .SH "DESCRIPTION"
36 .PP
37 This tool is part of the
38 \fBsamba\fR(7)
39 suite\&.
40 .PP
41 samba\-regedit
42 is a ncurses based tool to manage the Samba registry\&. It can be used to show/edit registry keys/subkeys and their values\&.
43 .SH "OPTIONS"
44 .PP
45 \-?|\-\-help
46 .RS 4
47 Print a summary of command line options\&.
48 .RE
49 .PP
50 \-\-usage
51 .RS 4
52 Display brief usage message\&.
53 .RE
54 .PP
55 \-d|\-\-debuglevel=level
56 .RS 4
57 \fIlevel\fR
58 is an integer from 0 to 10\&. The default value if this parameter is not specified is 1 for client applications\&.
59 .sp
60 The higher this value, the more detail will be logged to the log files about the activities of the server\&. At level 0, only critical errors and serious warnings will be logged\&. Level 1 is a reasonable level for day\-to\-day running \- it generates a small amount of information about operations carried out\&.
61 .sp
62 Levels above 1 will generate considerable amounts of log data, and should only be used when investigating a problem\&. Levels above 3 are designed for use only by developers and generate HUGE amounts of log data, most of which is extremely cryptic\&.
63 .sp
64 Note that specifying this parameter here will override the
65 \m[blue]\fBlog level\fR\m[]
66 parameter in the
67 /etc/samba/smb\&.conf
68 file\&.
69 .RE
70 .PP
71 \-\-debug\-stdout
72 .RS 4
73 This will redirect debug output to STDOUT\&. By default all clients are logging to STDERR\&.
74 .RE
75 .PP
76 \-\-configfile=<configuration file>
77 .RS 4
78 The file specified contains the configuration details required by the client\&. The information in this file can be general for client and server or only provide client specific like options such as
79 \m[blue]\fBclient smb encrypt\fR\m[]\&. See
80 /etc/samba/smb\&.conf
81 for more information\&. The default configuration file name is determined at compile time\&.
82 .RE
83 .PP
84 \-\-option=<name>=<value>
85 .RS 4
86 Set the
87 \fBsmb.conf\fR(5)
88 option "<name>" to value "<value>" from the command line\&. This overrides compiled\-in defaults and options read from the configuration file\&. If a name or a value includes a space, wrap whole \-\-option=name=value into quotes\&.
89 .RE
90 .PP
91 \-l|\-\-log\-basename=logdirectory
92 .RS 4
93 Base directory name for log/debug files\&. The extension
94 \fB"\&.progname"\fR
95 will be appended (e\&.g\&. log\&.smbclient, log\&.smbd, etc\&.\&.\&.)\&. The log file is never removed by the client\&.
96 .RE
97 .PP
98 \-\-leak\-report
99 .RS 4
100 Enable talloc leak reporting on exit\&.
101 .RE
102 .PP
103 \-\-leak\-report\-full
104 .RS 4
105 Enable full talloc leak reporting on exit\&.
106 .RE
107 .PP
108 \-V|\-\-version
109 .RS 4
110 Prints the program version number\&.
111 .RE
112 .PP
113 \-R|\-\-name\-resolve=NAME\-RESOLVE\-ORDER
114 .RS 4
115 This option is used to determine what naming services and in what order to resolve host names to IP addresses\&. The option takes a space\-separated string of different name resolution options\&. The best is to wrap the whole \-\-name\-resolve=NAME\-RESOLVE\-ORDER into quotes\&.
116 .sp
117 The options are: "lmhosts", "host", "wins" and "bcast"\&. They cause names to be resolved as follows:
118 .RS
119 .sp
120 .RS 4
121 .ie n \{\
122 \h'-04'\(bu\h'+03'\c
123 .\}
124 .el \{\
125 .sp -1
126 .IP \(bu 2.3
127 .\}
128 \fBlmhosts\fR: Lookup an IP address in the Samba lmhosts file\&. If the line in lmhosts has no name type attached to the NetBIOS name (see the
129 \fBlmhosts\fR(5)
130 for details) then any name type matches for lookup\&.
131 .RE
132 .sp
133 .RS 4
134 .ie n \{\
135 \h'-04'\(bu\h'+03'\c
136 .\}
137 .el \{\
138 .sp -1
139 .IP \(bu 2.3
140 .\}
141 \fBhost\fR: Do a standard host name to IP address resolution, using the system
142 /etc/hosts, NIS, or DNS lookups\&. This method of name resolution is operating system dependent, for instance on IRIX or Solaris this may be controlled by the
143 /etc/nsswitch\&.conf
144 file)\&. Note that this method is only used if the NetBIOS name type being queried is the 0x20 (server) name type, otherwise it is ignored\&.
145 .RE
146 .sp
147 .RS 4
148 .ie n \{\
149 \h'-04'\(bu\h'+03'\c
150 .\}
151 .el \{\
152 .sp -1
153 .IP \(bu 2.3
154 .\}
155 \fBwins\fR: Query a name with the IP address listed in the
156 \fIwins server\fR
157 parameter\&. If no WINS server has been specified this method will be ignored\&.
158 .RE
159 .sp
160 .RS 4
161 .ie n \{\
162 \h'-04'\(bu\h'+03'\c
163 .\}
164 .el \{\
165 .sp -1
166 .IP \(bu 2.3
167 .\}
168 \fBbcast\fR: Do a broadcast on each of the known local interfaces listed in the
169 \fIinterfaces\fR
170 parameter\&. This is the least reliable of the name resolution methods as it depends on the target host being on a locally connected subnet\&.
171 .RE
172 .sp
173 .RE
174 If this parameter is not set then the name resolve order defined in the
175 /etc/samba/smb\&.conf
176 file parameter (\m[blue]\fBname resolve order\fR\m[]) will be used\&.
177 .sp
178 The default order is lmhosts, host, wins, bcast\&. Without this parameter or any entry in the
179 \m[blue]\fBname resolve order\fR\m[]
180 parameter of the
181 /etc/samba/smb\&.conf
182 file, the name resolution methods will be attempted in this order\&.
183 .RE
184 .PP
185 \-O|\-\-socket\-options=SOCKETOPTIONS
186 .RS 4
187 TCP socket options to set on the client socket\&. See the socket options parameter in the
188 /etc/samba/smb\&.conf
189 manual page for the list of valid options\&.
190 .RE
191 .PP
192 \-m|\-\-max\-protocol=MAXPROTOCOL
193 .RS 4
194 The value of the parameter (a string) is the highest protocol level that will be supported by the client\&.
195 .sp
196 Note that specifying this parameter here will override the
197 \m[blue]\fBclient max protocol\fR\m[]
198 parameter in the
199 /etc/samba/smb\&.conf
200 file\&.
201 .RE
202 .PP
203 \-n|\-\-netbiosname=NETBIOSNAME
204 .RS 4
205 This option allows you to override the NetBIOS name that Samba uses for itself\&. This is identical to setting the
206 \m[blue]\fBnetbios name\fR\m[]
207 parameter in the
208 /etc/samba/smb\&.conf
209 file\&. However, a command line setting will take precedence over settings in
210 /etc/samba/smb\&.conf\&.
211 .RE
212 .PP
213 \-\-netbios\-scope=SCOPE
214 .RS 4
215 This specifies a NetBIOS scope that
216 nmblookup
217 will use to communicate with when generating NetBIOS names\&. For details on the use of NetBIOS scopes, see rfc1001\&.txt and rfc1002\&.txt\&. NetBIOS scopes are
218 \fIvery\fR
219 rarely used, only set this parameter if you are the system administrator in charge of all the NetBIOS systems you communicate with\&.
220 .RE
221 .PP
222 \-W|\-\-workgroup=WORKGROUP
223 .RS 4
224 Set the SMB domain of the username\&. This overrides the default domain which is the domain defined in smb\&.conf\&. If the domain specified is the same as the servers NetBIOS name, it causes the client to log on using the servers local SAM (as opposed to the Domain SAM)\&.
225 .sp
226 Note that specifying this parameter here will override the
227 \m[blue]\fBworkgroup\fR\m[]
228 parameter in the
229 /etc/samba/smb\&.conf
230 file\&.
231 .RE
232 .PP
233 \-r|\-\-realm=REALM
234 .RS 4
235 Set the realm for the domain\&.
236 .sp
237 Note that specifying this parameter here will override the
238 \m[blue]\fBrealm\fR\m[]
239 parameter in the
240 /etc/samba/smb\&.conf
241 file\&.
242 .RE
243 .PP
244 \-U|\-\-user=[DOMAIN\e]USERNAME[%PASSWORD]
245 .RS 4
246 Sets the SMB username or username and password\&.
247 .sp
248 If %PASSWORD is not specified, the user will be prompted\&. The client will first check the
249 \fBUSER\fR
250 environment variable (which is also permitted to also contain the password separated by a %), then the
251 \fBLOGNAME\fR
252 variable (which is not permitted to contain a password) and if either exists, the value is used\&. If these environmental variables are not found, the username found in a Kerberos Credentials cache may be used\&.
253 .sp
254 A third option is to use a credentials file which contains the plaintext of the username and password\&. This option is mainly provided for scripts where the admin does not wish to pass the credentials on the command line or via environment variables\&. If this method is used, make certain that the permissions on the file restrict access from unwanted users\&. See the
255 \fI\-A\fR
256 for more details\&.
257 .sp
258 Be cautious about including passwords in scripts or passing user\-supplied values onto the command line\&. For security it is better to let the Samba client tool ask for the password if needed, or obtain the password once with
259 kinit\&.
260 .sp
261 While Samba will attempt to scrub the password from the process title (as seen in ps), this is after startup and so is subject to a race\&.
262 .RE
263 .PP
264 \-N|\-\-no\-pass
265 .RS 4
266 If specified, this parameter suppresses the normal password prompt from the client to the user\&. This is useful when accessing a service that does not require a password\&.
267 .sp
268 Unless a password is specified on the command line or this parameter is specified, the client will request a password\&.
269 .sp
270 If a password is specified on the command line and this option is also defined the password on the command line will be silently ignored and no password will be used\&.
271 .RE
272 .PP
273 \-\-password
274 .RS 4
275 Specify the password on the commandline\&.
276 .sp
277 Be cautious about including passwords in scripts or passing user\-supplied values onto the command line\&. For security it is better to let the Samba client tool ask for the password if needed, or obtain the password once with
278 kinit\&.
279 .sp
280 If \-\-password is not specified, the tool will check the
281 \fBPASSWD\fR
282 environment variable, followed by
283 \fBPASSWD_FD\fR
284 which is expected to contain an open file descriptor (FD) number\&.
285 .sp
286 Finally it will check
287 \fBPASSWD_FILE\fR
288 (containing a file path to be opened)\&. The file should only contain the password\&. Make certain that the permissions on the file restrict access from unwanted users!
289 .sp
290 While Samba will attempt to scrub the password from the process title (as seen in ps), this is after startup and so is subject to a race\&.
291 .RE
292 .PP
293 \-\-pw\-nt\-hash
294 .RS 4
295 The supplied password is the NT hash\&.
296 .RE
297 .PP
298 \-A|\-\-authentication\-file=filename
299 .RS 4
300 This option allows you to specify a file from which to read the username and password used in the connection\&. The format of the file is:
301 .sp
302 .if n \{\
303 .RS 4
304 .\}
305 .nf
306 username = <value>
307 password = <value>
308 domain = <value>
309
310 .fi
311 .if n \{\
312 .RE
313 .\}
314 .sp
315 Make certain that the permissions on the file restrict access from unwanted users!
316 .RE
317 .PP
318 \-P|\-\-machine\-pass
319 .RS 4
320 Use stored machine account password\&.
321 .RE
322 .PP
323 \-\-simple\-bind\-dn=DN
324 .RS 4
325 DN to use for a simple bind\&.
326 .RE
327 .PP
328 \-\-use\-kerberos=desired|required|off
329 .RS 4
330 This parameter determines whether Samba client tools will try to authenticate using Kerberos\&. For Kerberos authentication you should use DNS names instead of IP addresses when connecting to a service\&. By default Samba client tools will try to use the default Kerberos credential cache (ccache)\&. In case the ccache does not exist or \-U|\-\-user option was specified, clients will ask to enter a password and will obtain a Kerberos ticket (kinit) for you\&. If you want to use an alternative Kerberos credentical cache, use the \-\-use\-krb5\-ccache option\&.
331 .sp
332 Note that specifying this parameter here will override the
333 \m[blue]\fBclient use kerberos\fR\m[]
334 parameter in the
335 /etc/samba/smb\&.conf
336 file\&.
337 .RE
338 .PP
339 \-\-use\-krb5\-ccache=CCACHE
340 .RS 4
341 Specifies the credential cache location for Kerberos authentication\&.
342 .sp
343 This will enforce \-\-use\-kerberos=required\&.
344 .RE
345 .PP
346 \-\-use\-winbind\-ccache
347 .RS 4
348 Try to use the credential cache by winbind\&.
349 .RE
350 .PP
351 \-\-client\-protection=sign|encrypt|off
352 .RS 4
353 Sets the connection protection the client tool should use\&.
354 .sp
355 Note that specifying this parameter here will override the
356 \m[blue]\fBclient protection\fR\m[]
357 parameter in the
358 /etc/samba/smb\&.conf
359 file\&.
360 .sp
361 In case you need more fine grained control you can use:
362 \-\-option=clientsmbencrypt=OPTION,
363 \-\-option=clientipcsigning=OPTION,
364 \-\-option=clientsigning=OPTION\&.
365 .RE
366 .SH "VERSION"
367 .PP
368 This man page is part of version 4\&.24\&.3\-Debian\-4\&.24\&.3+dfsg\-1 of the Samba suite\&.
369 .SH "SEE ALSO"
370 .PP
371 \fBsmbd\fR(8),
372 \fBsamba\fR(7)
373 and
374 \fBnet\fR(8)\&.
375 .SH "AUTHOR"
376 .PP
377 The original Samba software and related utilities were created by Andrew Tridgell\&. Samba is now developed by the Samba Team as an Open Source project similar to the way the Linux kernel is developed\&.
378 .PP
379 The samba\-regedit man page was written by Karolin Seeger\&.