comparison man/xemacs/packages.texi @ 540:bbfb58bc8dde

[xemacs-hg @ 2001-05-15 06:48:40 by youngs] Update package docs
author youngs
date Tue, 15 May 2001 06:49:13 +0000
parents 0784d089fdc9
children a90f7ebbad07
comparison
equal deleted inserted replaced
539:eec22eb29327 540:bbfb58bc8dde
488 488
489 @item XEMACS_PACKAGES = 489 @item XEMACS_PACKAGES =
490 This is where you set the normal packages that you 490 This is where you set the normal packages that you
491 want to install. eg: 491 want to install. eg:
492 @example 492 @example
493 XEMACS_PACKAGES = libs/xemacs-base comm/bbdb 493 XEMACS_PACKAGES = xemacs-packages/xemacs-base xemacs-packages/bbdb
494 @end example 494 @end example
495 495
496 @item XEMACS_STAGING = $@{XEMACS_PACKAGES_BASE@}/../Packages 496 @item XEMACS_STAGING = $@{XEMACS_PACKAGES_BASE@}/../Packages
497 Set this to where you want normal packages to be 497 Set this to where you want normal packages to be
498 installed to. 498 installed to.
507 507
508 @item MULE_PACKAGES = 508 @item MULE_PACKAGES =
509 Same as for 'XEMACS_PACKAGES' except you list the Mule 509 Same as for 'XEMACS_PACKAGES' except you list the Mule
510 packages you want to install here. eg: 510 packages you want to install here. eg:
511 @example 511 @example
512 MULE_PACKAGES = mule/mule-base mule/skk 512 MULE_PACKAGES = mule-packages/mule-base mule-packages/skk
513 @end example 513 @end example
514 514
515 @item MULE_STAGING = $@{XEMACS_PACKAGES_BASE@}/../Mule-Packages 515 @item MULE_STAGING = $@{XEMACS_PACKAGES_BASE@}/../Mule-Packages
516 Set this to where you want Mule packages installed 516 Set this to where you want Mule packages installed
517 to. Note: 'make bindist' does not use this variable. 517 to. Note: 'make bindist' does not use this variable.
606 606
607 The first few @code{make} variables defined are @code{VERSION}, 607 The first few @code{make} variables defined are @code{VERSION},
608 @code{AUTHOR_VERSION}, @code{MAINTAINER}, @code{PACKAGE}, 608 @code{AUTHOR_VERSION}, @code{MAINTAINER}, @code{PACKAGE},
609 @code{PKG_TYPE}, @code{REQUIRES}, and @code{CATEGORY}. All but one were 609 @code{PKG_TYPE}, @code{REQUIRES}, and @code{CATEGORY}. All but one were
610 described in the description of @file{package-info.in}. The last is an 610 described in the description of @file{package-info.in}. The last is an
611 administrative grouping. Current categories include @code{comm}, 611 administrative grouping. Current categories include @code{standard},
612 @code{games}, @code{libs}, @code{mule}, @code{oa}, @code{os}, 612 and @code{mule}.
613 @code{prog}, and @code{wp}. @ref{Available Packages}, for a list of
614 categories.
615 613
616 Next, define the variable @code{ELCS}. This contains the list of the 614 Next, define the variable @code{ELCS}. This contains the list of the
617 byte-compiled Lisp files used by the package. These files and their 615 byte-compiled Lisp files used by the package. These files and their
618 @file{.el} versions will be included in the binary package. If there 616 @file{.el} versions will be included in the binary package. If there
619 are other files (such as extra Lisp sources or an upstream 617 are other files (such as extra Lisp sources or an upstream
670 This section lists the Lisp packages that are currently available from 668 This section lists the Lisp packages that are currently available from
671 xemacs.org and it's mirrors. If a particular package that you are 669 xemacs.org and it's mirrors. If a particular package that you are
672 looking for isn't here, please send a message to the 670 looking for isn't here, please send a message to the
673 @email{xemacs-beta@@xemacs.org, XEmacs Beta list}. 671 @email{xemacs-beta@@xemacs.org, XEmacs Beta list}.
674 672
675 This data is up-to-date as of January 17, 2001. 673 This data is up-to-date as of May 15, 2001.
676 674
677 @subsection Library Packages (libs) 675 @subsection Normal Packages
678 676 A very broad selection of elisp packages.
679 These packages are required to build and support most of the rest of
680 XEmacs. By design, xemacs-base is a `regular' package. Use restraint
681 when adding new files there as it is required by almost everything.
682 677
683 @table @file 678 @table @file
684 @item Sun 679 @item Sun
685 Support for Sparcworks. 680 Support for Sparcworks.
686 681
682 @item ada
683 Ada language support.
684
687 @item apel 685 @item apel
688 A Portable Emacs Library. Used by XEmacs MIME support. 686 A Portable Emacs Library. Used by XEmacs MIME support.
687
688 @item auctex
689 Basic TeX/LaTeX support.
690
691 @item bbdb
692 The Big Brother Data Base
693
694 @item build
695 Build XEmacs using custom widgets.
696
697 @item c-support
698 Basic single-file add-ons for editing C code.
699
700 @item calc
701 Emacs calculator.
702
703 @item calendar
704 Calendar and diary support.
705
706 @item cc-mode
707 C, C++ and Java language support.
708
709 @item cookie
710 Spook and Yow (Zippy quotes).
711
712 @item crisp
713 Crisp/Brief emulation.
714
715 @item debug
716 GUD, gdb, dbx debugging support.
689 717
690 @item dired 718 @item dired
691 The DIRectory EDitor is for manipulating, and running commands on 719 The DIRectory EDitor is for manipulating, and running commands on
692 files in a directory. 720 files in a directory.
693 721
694 @item edebug 722 @item edebug
695 A Lisp debugger. 723 A Lisp debugger.
696 724
725 @item ediff
726 Interface over patch.
727
728 @item edit-utils
729 Single file lisp packages for various XEmacs goodies. Load this and
730 weed out the junk you don't want.
731
732 @item edt
733 DEC EDIT/EDT emulation.
734
697 @item efs 735 @item efs
698 Treat files on remote systems the same as local files. 736 Treat files on remote systems the same as local files.
699 737
738 @item eicq
739 ICQ Client developed and tested on Linux x86;
740 only supported on that platform
741
742 @item eieio
743 Enhanced Implementation of Emacs Interpreted Objects.
744
700 @item elib 745 @item elib
701 Portable Emacs Lisp utilities library. 746 Portable Emacs Lisp utilities library.
702 747
748 @item emerge
749 Another interface over patch.
750
751 @item eshell
752 Command shell implemented entirely in Emacs Lisp.
753
754 @item eterm
755 Terminal emulator.
756
757 @item eudc
758 Emacs Unified Directory Client (LDAP, PH).
759
760 @item footnote
761 Footnoting in mail message editing modes.
762
763 @item forms
764 Forms editing support (obsolete, use the built-in Widget instead).
765
766 @item frame-icon
767 Provide a WM icon based on major mode.
768
703 @item fsf-compat 769 @item fsf-compat
704 FSF Emacs compatibility files. 770 FSF Emacs compatibility files.
705 771
772 @item games
773 Tetris, Sokoban, and Snake.
774
775 @item gnats
776 XEmacs bug reports.
777
778 @item gnus
779 The Gnus Newsreader and Mailreader.
780
781 @item hm--html-menus
782 HTML editing.
783
784 @item idlwave
785 Editing and Shell mode for the Interactive Data Language.
786
787 @item igrep
788 Enhanced front-end for Grep.
789
790 @item ilisp
791 Front-end for Inferior Lisp.
792
793 @item ispell
794 Spell-checking with ispell.
795
796 @item jde
797 Java language and development support.
798
706 @item mail-lib 799 @item mail-lib
707 Fundamental lisp files for providing email support. 800 Fundamental lisp files for providing email support.
708 801
802 @item mailcrypt
803 Support for messaging encryption with PGP.
804
805 @item mew
806 Messaging in an Emacs World.
807
808 @item mh-e
809 Front end support for MH.
810
811 @item mine
812 Minehunt.
813
814 @item misc-games
815 Other amusements and diversions.
816
817 @item net-utils
818 Miscellaneous Networking Utilities. This is a single-file package and
819 files may be deleted at will.
820
821 @item os-utils
822 Miscellaneous single-file O/S utilities, for printing, archiving,
823 compression, remote shells, etc.
824
825 @item pc
826 PC style interface emulation.
827
828 @item pcl-cvs
829 CVS frontend.
830
831 @item pcomplete
832 Provides programmatic completion.
833
834 @item prog-modes
835 Miscellaneous single-file lisp files for various programming languages.
836
837 @item ps-print-nomule
838 Old, but no-Mule safe ps-print.
839
840 @item psgml
841 Validated HTML/SGML editing.
842
843 @item reftex
844 Emacs support for LaTeX cross-references, citations.
845
846 @item rmail
847 An obsolete Emacs mailer. If you do not already use it don't start.
848
849 @item scheme
850 Front-end support for Inferior Scheme.
851
852 @item semantic
853 Semantic bovinator.
854
855 @item sgml
856 SGML/Linuxdoc-SGML editing.
857
858 @item sh-script
859 Support for editing shell scripts.
860
861 @item slider
862 User interface tool.
863
709 @item sounds-au 864 @item sounds-au
710 XEmacs Sun sound files. 865 XEmacs Sun sound files.
711 866
712 @item sounds-wav 867 @item sounds-wav
713 XEmacs Microsoft sound files. 868 XEmacs Microsoft sound files.
714 869
870 @item speedbar
871 Provides a separate frame with convenient references.
872
873 @item strokes
874 Mouse enhancement utility.
875
876 @item supercite
877 An Emacs citation tool. Useful with all Emacs Mailers and Newsreaders.
878
879 @item texinfo
880 XEmacs TeXinfo support.
881
882 @item text-modes
883 Various single file lisp packages for editing text files.
884
885 @item textools
886 Single-file TeX support.
887
888 @item time
889 Display time & date on the modeline.
890
891 @item tm
892 Emacs MIME support. Not needed for Gnus >= 5.8.0
893
715 @item tooltalk 894 @item tooltalk
716 Support for building with Tooltalk. 895 Support for building with Tooltalk.
896
897 @item tpu
898 DEC EDIT/TPU support.
899
900 @item vc
901 Version Control for Free systems.
902
903 @item vc-cc
904 Version Control for ClearCase. This package will shortly be
905 replaced with clearcase.el
906
907 @item vhdl
908 Support for VHDL.
909
910 @item view-process
911 A Unix process browsing tool.
912
913 @item viper
914 VI emulation support.
915
916 @item vm
917 An Emacs mailer.
918
919 @item w3
920 A Web browser.
717 921
718 @item xemacs-base 922 @item xemacs-base
719 Fundamental XEmacs support. Install this unless you wish a totally 923 Fundamental XEmacs support. Install this unless you wish a totally
720 naked XEmacs. 924 naked XEmacs.
721 925
722 @item xemacs-devel 926 @item xemacs-devel
723 XEmacs Lisp developer support. This package contains utilities for 927 XEmacs Lisp developer support. This package contains utilities for
724 supporting Lisp development. It is a single-file package so it may be 928 supporting Lisp development. It is a single-file package so it may be
725 tailored. 929 tailored.
726 @end table 930
727 931 @item xslt-process
728 @subsection Communications Packages (comm) 932 A minor mode for (X)Emacs which allows running an XSLT processor on a
729 933 buffer.
730 These packages provide support for various communications, primarily
731 email and usenet.
732
733 @table @file
734 @item bbdb
735 The Big Brother Data Base
736
737 @item eicq
738 ICQ Client developed and tested on Linux x86;
739 only supported on that platform
740
741 @item eudc
742 Emacs Unified Directory Client (LDAP, PH).
743
744 @item footnote
745 Footnoting in mail message editing modes.
746
747 @item gnats
748 XEmacs bug reports.
749
750 @item gnus
751 The Gnus Newsreader and Mailreader.
752
753 @item mailcrypt
754 Support for messaging encryption with PGP.
755
756 @item mew
757 Messaging in an Emacs World.
758
759 @item mh-e
760 Front end support for MH.
761
762 @item net-utils
763 Miscellaneous Networking Utilities. This is a single-file package and
764 files may be deleted at will.
765
766 @item rmail
767 An obsolete Emacs mailer. If you do not already use it don't start.
768
769 @item supercite
770 An Emacs citation tool. Useful with all Emacs Mailers and Newsreaders.
771
772 @item tm
773 Emacs MIME support. Not needed for Gnus >= 5.8.0
774
775 @item vm
776 An Emacs mailer.
777
778 @item w3
779 A Web browser.
780 934
781 @item zenirc 935 @item zenirc
782 ZENIRC IRC Client. 936 ZENIRC IRC Client.
783 @end table
784
785 @subsection Games and Amusements (games)
786
787 All work and no play...
788
789 @table @file
790 @item cookie
791 Spook and Yow (Zippy quotes).
792
793 @item games
794 Tetris, Sokoban, and Snake.
795
796 @item mine
797 Minehunt.
798
799 @item misc-games
800 Other amusements and diversions.
801 @end table 937 @end table
802 938
803 @subsection Mule Support (mule) 939 @subsection Mule Support (mule)
804 940
805 MULti-lingual Enhancement. Support for world scripts such as 941 MULti-lingual Enhancement. Support for world scripts such as
831 @item skk 967 @item skk
832 Another Japanese Language Input Method. Can be used without a 968 Another Japanese Language Input Method. Can be used without a
833 separate process running as a dictionary server. 969 separate process running as a dictionary server.
834 @end table 970 @end table
835 971
836 @subsection Productivity Packages (oa)
837
838 Things to make life a little easier.
839
840 @table @file
841 @item calc
842 Emacs calculator.
843
844 @item calendar
845 Calendar and diary support.
846
847 @item edit-utils
848 Single file lisp packages for various XEmacs goodies. Load this and
849 weed out the junk you don't want.
850
851 @item forms
852 Forms editing support (obsolete, use the built-in Widget instead).
853
854 @item frame-icon
855 Provide a WM icon based on major mode.
856
857 @item hm--html-menus
858 HTML editing.
859
860 @item ispell
861 Spell-checking with ispell.
862
863 @item pc
864 PC style interface emulation.
865
866 @item psgml
867 Validated HTML/SGML editing.
868
869 @item sgml
870 SGML/Linuxdoc-SGML editing.
871
872 @item slider
873 User interface tool.
874
875 @item speedbar
876 Provides a separate frame with convenient references.
877
878 @item strokes
879 Mouse enhancement utility.
880
881 @item text-modes
882 Various single file lisp packages for editing text files.
883
884 @item time
885 Display time & date on the modeline.
886 @end table
887
888 @subsection Operating System Utilities (os)
889
890 Tools for working with the operating system.
891
892 @table @file
893 @item eshell
894 Command shell implemented entirely in Emacs Lisp.
895
896 @item eterm
897 Terminal emulator.
898
899 @item igrep
900 Enhanced front-end for Grep.
901
902 @item ilisp
903 Front-end for Inferior Lisp.
904
905 @item os-utils
906 Miscellaneous single-file O/S utilities, for printing, archiving,
907 compression, remote shells, etc.
908
909 @item pcomplete
910 Provides programmatic completion.
911
912 @item ps-print-nomule
913 Old, but no-Mule safe ps-print.
914
915 @item view-process
916 A Unix process browsing tool.
917 @end table
918
919 @subsection Program Editing Support (prog)
920
921 XEmacs supports a multitude of programming languages. These
922 packages will help your coding.
923
924 @table @file
925 @item ada
926 Ada language support.
927
928 @item c-support
929 Basic single-file add-ons for editing C code.
930
931 @item cc-mode
932 C, C++ and Java language support.
933
934 @item debug
935 GUD, gdb, dbx debugging support.
936
937 @item ediff
938 Interface over patch.
939
940 @item emerge
941 Another interface over patch.
942
943 @item idlwave
944 Editing and Shell mode for the Interactive Data Language.
945
946 @item jde
947 Java language and development support.
948
949 @item pcl-cvs
950 CVS frontend.
951
952 @item prog-modes
953 Miscellaneous single-file lisp files for various programming languages.
954
955 @item scheme
956 Front-end support for Inferior Scheme.
957
958 @item semantic
959 Semantic bovinator.
960
961 @item sh-script
962 Support for editing shell scripts.
963
964 @item vc
965 Version Control for Free systems.
966
967 @item vc-cc
968 Version Control for ClearCase. This package will shortly be
969 replaced with clearcase.el
970
971 @item vhdl
972 Support for VHDL.
973 @end table
974
975 @subsection Word Processing (wp)
976
977 Working with text.
978
979 @table @file
980 @item auctex
981 Basic TeX/LaTeX support.
982
983 @item crisp
984 Crisp/Brief emulation.
985
986 @item edt
987 DEC EDIT/EDT emulation.
988
989 @item reftex
990 Emacs support for LaTeX cross-references, citations.
991
992 @item texinfo
993 XEmacs TeXinfo support.
994
995 @item textools
996 Single-file TeX support.
997
998 @item tpu
999 DEC EDIT/TPU support.
1000
1001 @item viper
1002 VI emulation support.
1003 @end table
1004