| blob | 91f37e8584fbd3c7a6e74008c64f128039cdf7c3 |
1 ;;; net-utils.el --- network functions
3 ;; Copyright (C) 1998, 1999, 2000, 2001, 2002, 2003, 2004,
4 ;; 2005, 2006, 2007 Free Software Foundation, Inc.
6 ;; Author: Peter Breton <pbreton@cs.umb.edu>
7 ;; Created: Sun Mar 16 1997
8 ;; Keywords: network comm
10 ;; This file is part of GNU Emacs.
12 ;; GNU Emacs is free software; you can redistribute it and/or modify
13 ;; it under the terms of the GNU General Public License as published by
14 ;; the Free Software Foundation; either version 3, or (at your option)
15 ;; any later version.
17 ;; GNU Emacs is distributed in the hope that it will be useful,
18 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
19 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
20 ;; GNU General Public License for more details.
22 ;; You should have received a copy of the GNU General Public License
23 ;; along with GNU Emacs; see the file COPYING. If not, write to the
24 ;; Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
25 ;; Boston, MA 02110-1301, USA.
27 ;;; Commentary:
29 ;;
30 ;; There are three main areas of functionality:
31 ;;
32 ;; * Wrap common network utility programs (ping, traceroute, netstat,
33 ;; nslookup, arp, route). Note that these wrappers are of the diagnostic
34 ;; functions of these programs only.
35 ;;
36 ;; * Implement some very basic protocols in Emacs Lisp (finger and whois)
37 ;;
38 ;; * Support connections to HOST/PORT, generally for debugging and the like.
39 ;; In other words, for doing much the same thing as "telnet HOST PORT", and
40 ;; then typing commands.
41 ;;
42 ;; PATHS
43 ;;
44 ;; On some systems, some of these programs are not in normal user path,
45 ;; but rather in /sbin, /usr/sbin, and so on.
48 ;;; Code:
52 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
53 ;; Customization Variables
54 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
57 "Network utility functions."
64 "If non-nil, remove control-Ms from output."
70 "tracert"
72 "Program to trace network hops to a destination."
77 "Options for the traceroute program."
82 "Program to send network test packets to a host."
86 ;; On GNU/Linux and Irix, the system's ping program seems to send packets
87 ;; indefinitely unless told otherwise
91 "Options for the ping program.
92 These options can be used to limit how many ICMP packets are emitted."
98 "ipconfig"
100 "Program to print network configuration information."
108 "Options for ipconfig-program."
113 "Program to print network statistics."
119 "Options for netstat-program."
124 "Program to print IP to address translation tables."
130 "Options for arp-program."
136 "route"
138 "Program to print routing tables."
146 "Options for route-program."
151 "Program to interactively query DNS information."
156 "List of options to pass to the nslookup program."
161 "Regexp to match the nslookup prompt.
163 This variable is only used if the variable
164 `comint-use-prompt-regexp' is non-nil."
169 "Program to query DNS information."
174 "Progam to run to do FTP transfers."
179 "List of options to pass to the FTP program."
184 "Regexp which matches the FTP program's prompt.
186 This variable is only used if the variable
187 `comint-use-prompt-regexp' is non-nil."
192 "Smbclient program."
197 "List of options to pass to the smbclient program."
202 "Regexp which matches the smbclient program's prompt.
204 This variable is only used if the variable
205 `comint-use-prompt-regexp' is non-nil."
210 "Program to interactively query DNS information."
213 )
216 "List of options to pass to the dns-lookup program."
219 )
221 ;; Internal variables
225 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
226 ;; Nslookup goodies
227 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
239 ;; Dotted quads
245 ;; Host names
256 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
257 ;; Utility functions
258 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
260 ;; Simplified versions of some at-point functions from ffap.el.
261 ;; It's not worth loading all of ffap just for these.
287 "Remove trailing control Ms."
300 ;; Insert the text, moving the process-marker.
308 "Run a network information program."
317 buf))
319 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
320 ;; Wrappers for external network programs
321 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
323 ;;;###autoload
325 "Run traceroute program for TARGET."
334 traceroute-program
335 options)))
337 ;;;###autoload
339 "Ping HOST.
340 If your system's ping continues until interrupted, you can try setting
341 `ping-program-options'."
351 ping-program
352 options)))
354 ;;;###autoload
356 "Run ipconfig program."
359 "Ipconfig"
361 ipconfig-program
362 ipconfig-program-options))
364 ;; This is the normal name on most Unixes.
365 ;;;###autoload
368 ;;;###autoload
370 "Run netstat program."
373 "Netstat"
375 netstat-program
376 netstat-program-options))
378 ;;;###autoload
380 "Run the arp program."
383 "Arp"
385 arp-program
386 arp-program-options))
388 ;;;###autoload
390 "Run the route program."
393 "Route"
395 route-program
396 route-program-options))
398 ;; FIXME -- Needs to be a process filter
399 ;; (defun netstat-with-filter (filter)
400 ;; "Run netstat program."
401 ;; (interactive "sFilter: ")
402 ;; (netstat)
403 ;; (set-buffer (get-buffer "*Netstat*"))
404 ;; (goto-char (point-min))
405 ;; (delete-matching-lines filter))
407 ;;;###autoload
409 "Lookup the DNS information for HOST."
417 "Nslookup"
422 nslookup-program
423 options)))
425 ;;;###autoload
427 "Run nslookup program."
433 ;; Using a derived mode gives us keymaps, hooks, etc.
435 "Major mode for interacting with the nslookup program."
444 ;;;###autoload
446 "Lookup the DNS information for HOST (name or IP address)."
459 dns-lookup-program
460 options
461 )))
463 ;;;###autoload
465 "Run dig program."
471 "Lookup host: "
475 "Dig"
480 dig-program
483 ;; This is a lot less than ange-ftp, but much simpler.
484 ;;;###autoload
486 "Run ftp program."
502 "Major mode for interacting with the ftp program."
505 ;; Only add the password-prompting hook if it's not already in the
506 ;; global hook list. This stands a small chance of losing, if it's
507 ;; later removed from the global list (very small, since any
508 ;; password prompts will probably immediately follow the initial
509 ;; connection), but it's better than getting prompted twice for the
510 ;; same password.
514 nil t)))
516 ;; Occasionally useful
520 "Connect to SERVICE on HOST via SMB."
539 "List services on HOST."
552 "Major mode for interacting with the smbclient program."
555 ;; Only add the password-prompting hook if it's not already in the
556 ;; global hook list. This stands a small chance of losing, if it's
557 ;; later removed from the global list (very small, since any
558 ;; password prompts will probably immediately follow the initial
559 ;; connection), but it's better than getting prompted twice for the
560 ;; same password.
564 nil t)))
567 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
568 ;; Network Connections
569 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
571 ;; Full list is available at:
572 ;; http://www.iana.org/assignments/port-numbers
597 "Alist of services and associated TCP port numbers.
600 ;; Workhorse macro
610 ,process-name
611 buf
612 ,host
623 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
624 ;; Simple protocols
625 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
628 "A list of regular expressions matching host names.
629 If a host name passed to `finger' matches one of these regular
630 expressions, it is assumed to be a host that doesn't accept
631 queries of the form USER@HOST, and wants a query containing USER only."
636 ;; Finger protocol
637 ;;;###autoload
639 "Finger USER on HOST."
640 ;; One of those great interactive statements that's actually
641 ;; longer than the function call! The idea is that if the user
642 ;; uses a string like "pbreton@cs.umb.edu", we won't ask for the
643 ;; host name. If we don't see an "@", we'll prompt for the host.
657 found)
664 process-name
665 host
667 user-and-host)))
670 "Default host name for the whois service."
684 "A list of whois servers that can be queried."
688 ;; FIXME: modern whois clients include a much better tld <-> whois server
689 ;; list, Emacs should probably avoid specifying the server as the client
690 ;; will DTRT anyway... -rfr
707 "Alist to map top level domains to whois servers."
712 "If non-nil then whois will try to deduce the appropriate whois
713 server from the query. If the query doesn't look like a domain or hostname
714 then the server named by `whois-server-name' is used."
719 "Return the top level domain of `host', or nil if it isn't a domain name."
725 nil
728 ;; Whois protocol
729 ;;;###autoload
731 "Send SEARCH-STRING to server defined by the `whois-server-name' variable.
732 If `whois-guess-server' is non-nil, then try to deduce the correct server
733 from SEARCH-STRING. With argument, prompt for whois server."
737 whois-server-tld)
738 nil))
741 whois-server-name))
746 server-name)))
748 "Whois"
749 host
751 search-string)))
754 "Server which provides inverse DNS mapping."
758 ;;;###autoload
764 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
765 ;;; General Network connection
766 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
768 ;; Using a derived mode gives us keymaps, hooks, etc.
770 network-connection-mode comint-mode "Network-Connection"
779 ;;;###autoload
781 "Open a network connection to SERVICE on HOST."
790 network-connection-service-alist))))
792 host
795 ;;;###autoload
797 "Open a network connection to HOST on PORT."
802 "Open a network connection to SERVICE on HOST."
809 process-name
817 "Reconnect a network connection, preserving the old input ring."
830 service
837 ;;; arch-tag: 97119e91-9edb-4376-838b-bf7058fa1314
838 ;;; net-utils.el ends here