comparison lisp/net/net-utils.el @ 80216:e2cf0e9f1f88

(ftp-program): Fix typo in docstring. (ifconfig-program-options, netstat-program-options, arp-program-options, route-program-options, nslookup-program-options, ftp-program-options, smbclient-program-options, dns-lookup-program-options, arp, route): Doc fixes.
author Juanma Barranquero <lekktu@gmail.com>
date Tue, 26 Feb 2008 11:55:41 +0000
parents b0ced9a93377
children 4054054dd212
comparison
equal deleted inserted replaced
80215:a28b5b3bf7eb 80216:e2cf0e9f1f88
105 105
106 (defcustom ifconfig-program-options 106 (defcustom ifconfig-program-options
107 (list 107 (list
108 (if (eq system-type 'windows-nt) 108 (if (eq system-type 'windows-nt)
109 "/all" "-a")) 109 "/all" "-a"))
110 "Options for `ifconfig-program'." 110 "Options for the ifconfig program."
111 :group 'net-utils 111 :group 'net-utils
112 :type '(repeat string)) 112 :type '(repeat string))
113 113
114 (define-obsolete-variable-alias 'ipconfig-program-options 114 (define-obsolete-variable-alias 'ipconfig-program-options
115 'ifconfig-program-options "22.2") 115 'ifconfig-program-options "22.2")
116 116
117 (defcustom netstat-program "netstat" 117 (defcustom netstat-program "netstat"
118 "Program to print network statistics." 118 "Program to print network statistics."
119 :group 'net-utils 119 :group 'net-utils
120 :type 'string) 120 :type 'string)
121 121
122 (defcustom netstat-program-options 122 (defcustom netstat-program-options
123 (list "-a") 123 (list "-a")
124 "Options for netstat-program." 124 "Options for the netstat program."
125 :group 'net-utils 125 :group 'net-utils
126 :type '(repeat string)) 126 :type '(repeat string))
127 127
128 (defcustom arp-program "arp" 128 (defcustom arp-program "arp"
129 "Program to print IP to address translation tables." 129 "Program to print IP to address translation tables."
130 :group 'net-utils 130 :group 'net-utils
131 :type 'string) 131 :type 'string)
132 132
133 (defcustom arp-program-options 133 (defcustom arp-program-options
134 (list "-a") 134 (list "-a")
135 "Options for arp-program." 135 "Options for the arp program."
136 :group 'net-utils 136 :group 'net-utils
137 :type '(repeat string)) 137 :type '(repeat string))
138 138
139 (defcustom route-program 139 (defcustom route-program
140 (if (eq system-type 'windows-nt) 140 (if (eq system-type 'windows-nt)
146 146
147 (defcustom route-program-options 147 (defcustom route-program-options
148 (if (eq system-type 'windows-nt) 148 (if (eq system-type 'windows-nt)
149 (list "print") 149 (list "print")
150 (list "-r")) 150 (list "-r"))
151 "Options for route-program." 151 "Options for the route program."
152 :group 'net-utils 152 :group 'net-utils
153 :type '(repeat string)) 153 :type '(repeat string))
154 154
155 (defcustom nslookup-program "nslookup" 155 (defcustom nslookup-program "nslookup"
156 "Program to interactively query DNS information." 156 "Program to interactively query DNS information."
157 :group 'net-utils 157 :group 'net-utils
158 :type 'string) 158 :type 'string)
159 159
160 (defcustom nslookup-program-options nil 160 (defcustom nslookup-program-options nil
161 "List of options to pass to the nslookup program." 161 "Options for the nslookup program."
162 :group 'net-utils 162 :group 'net-utils
163 :type '(repeat string)) 163 :type '(repeat string))
164 164
165 (defcustom nslookup-prompt-regexp "^> " 165 (defcustom nslookup-prompt-regexp "^> "
166 "Regexp to match the nslookup prompt. 166 "Regexp to match the nslookup prompt.
168 This variable is only used if the variable 168 This variable is only used if the variable
169 `comint-use-prompt-regexp' is non-nil." 169 `comint-use-prompt-regexp' is non-nil."
170 :group 'net-utils 170 :group 'net-utils
171 :type 'regexp) 171 :type 'regexp)
172 172
173 (defcustom dig-program "dig" 173 (defcustom dig-program "dig"
174 "Program to query DNS information." 174 "Program to query DNS information."
175 :group 'net-utils 175 :group 'net-utils
176 :type 'string) 176 :type 'string)
177 177
178 (defcustom ftp-program "ftp" 178 (defcustom ftp-program "ftp"
179 "Progam to run to do FTP transfers." 179 "Program to run to do FTP transfers."
180 :group 'net-utils 180 :group 'net-utils
181 :type 'string) 181 :type 'string)
182 182
183 (defcustom ftp-program-options nil 183 (defcustom ftp-program-options nil
184 "List of options to pass to the FTP program." 184 "Options for the ftp program."
185 :group 'net-utils 185 :group 'net-utils
186 :type '(repeat string)) 186 :type '(repeat string))
187 187
188 (defcustom ftp-prompt-regexp "^ftp>" 188 (defcustom ftp-prompt-regexp "^ftp>"
189 "Regexp which matches the FTP program's prompt. 189 "Regexp which matches the FTP program's prompt.
197 "Smbclient program." 197 "Smbclient program."
198 :group 'net-utils 198 :group 'net-utils
199 :type 'string) 199 :type 'string)
200 200
201 (defcustom smbclient-program-options nil 201 (defcustom smbclient-program-options nil
202 "List of options to pass to the smbclient program." 202 "Options for the smbclient program."
203 :group 'net-utils 203 :group 'net-utils
204 :type '(repeat string)) 204 :type '(repeat string))
205 205
206 (defcustom smbclient-prompt-regexp "^smb: \>" 206 (defcustom smbclient-prompt-regexp "^smb: \>"
207 "Regexp which matches the smbclient program's prompt. 207 "Regexp which matches the smbclient program's prompt.
209 This variable is only used if the variable 209 This variable is only used if the variable
210 `comint-use-prompt-regexp' is non-nil." 210 `comint-use-prompt-regexp' is non-nil."
211 :group 'net-utils 211 :group 'net-utils
212 :type 'regexp) 212 :type 'regexp)
213 213
214 (defcustom dns-lookup-program "host" 214 (defcustom dns-lookup-program "host"
215 "Program to interactively query DNS information." 215 "Program to interactively query DNS information."
216 :group 'net-utils 216 :group 'net-utils
217 :type 'string 217 :type 'string)
218 ) 218
219 219 (defcustom dns-lookup-program-options nil
220 (defcustom dns-lookup-program-options nil 220 "Options for the dns-lookup program."
221 "List of options to pass to the dns-lookup program." 221 :group 'net-utils
222 :group 'net-utils 222 :type '(repeat string))
223 :type '(repeat string)
224 )
225 223
226 ;; Internal variables 224 ;; Internal variables
227 (defvar network-connection-service nil) 225 (defvar network-connection-service nil)
228 (defvar network-connection-host nil) 226 (defvar network-connection-host nil)
229 227
380 netstat-program 378 netstat-program
381 netstat-program-options)) 379 netstat-program-options))
382 380
383 ;;;###autoload 381 ;;;###autoload
384 (defun arp () 382 (defun arp ()
385 "Run the arp program." 383 "Run arp program."
386 (interactive) 384 (interactive)
387 (net-utils-run-program 385 (net-utils-run-program
388 "Arp" 386 "Arp"
389 (concat "** Arp ** " arp-program " ** ") 387 (concat "** Arp ** " arp-program " ** ")
390 arp-program 388 arp-program
391 arp-program-options)) 389 arp-program-options))
392 390
393 ;;;###autoload 391 ;;;###autoload
394 (defun route () 392 (defun route ()
395 "Run the route program." 393 "Run route program."
396 (interactive) 394 (interactive)
397 (net-utils-run-program 395 (net-utils-run-program
398 "Route" 396 "Route"
399 (concat "** Route ** " route-program " ** ") 397 (concat "** Route ** " route-program " ** ")
400 route-program 398 route-program
460 (concat "** " 458 (concat "** "
461 (mapconcat 'identity 459 (mapconcat 'identity
462 (list "DNS Lookup" host dns-lookup-program) 460 (list "DNS Lookup" host dns-lookup-program)
463 " ** ")) 461 " ** "))
464 dns-lookup-program 462 dns-lookup-program
465 options 463 options)))
466 )))
467 464
468 ;;;###autoload 465 ;;;###autoload
469 (defun run-dig (host) 466 (defun run-dig (host)
470 "Run dig program." 467 "Run dig program."
471 (interactive 468 (interactive