cgit.sxemacs.org Git - sxemacs/blob - contrib/README

   1 -*- text -*-
   2
   3 In here you'll find a few odds and sods that may or may not be
   4 useful.
   5
   6 File List:
   7 =========
   8         do_builds.sh..............automate builds
   9         make-pkg.sh...............bash script to create a SXEmacs tar package
  10         pop3.el.patch.............SXEmacs native OpenSSL goodies
  11         report-build-failure.sh...bash script to send a build report failure
  12         show-tty-256-colors.pl....Perl script to test 256 color output on terminal
  13         smtpmail.el.patch.........SXEmacs native OpenSSL goodies
  14         starttls.el.patch.........SXEmacs native OpenSSL goodies
  15         tar-build-failure.sh......bash script w/ tar of build report failure
  16         tty-colors.c..............C program to check the terminal color definitions
  17
  18 More Info:
  19 =========
  20
  21
  22 do_builds.sh:
  23 ------------
  24
  25 This script allows the automation of the builds with several different
  26 configure options.
  27 It does autogen.sh, configure and reports success and of failure.
  28 To setup:
  29
  30    1. Create a directory *outside* of the source directory in order
  31    not to be "hammered" by autogen. You use a build directory directly
  32    below the top source directory IF you do not set the HAMMER variable
  33    in the configuration file (,,conf)
  34
  35    2. Run the script from *that* directory. That will create a ,,conf
  36    file, which you *must* edit to at least point to the sxemacs source
  37    directory.
  38
  39    3. Create several .conf files, one for each of you different
  40    configurations. On this file place all the options you'd usually
  41    pass on to configure. If you would set environment variables like
  42    CC or CFLAGS, you can do so at the end of the file with <var>=<value>
  43
  44    4. Execute do_builds.sh
  45
  46 Nelson Ferreira <njsf@sxemacs.org>
  47
  48 make-pkg.sh:
  49 -------------
  50 This script conveniently creates a tar from your workspace for use
  51 in systems without proper autoconf or tla.
  52
  53 It needs to be run from the top of source directory and requires
  54 the name of the package to be given.
  55
  56 Usage: contrib/make-pkg.sh <package-name> [<package-location>]
  57
  58 Example: contrib/make-pkg.sh sxemacs-22.1.9 $HOME/public_html
  59 will create a sxemacs-22.1.9.tar.gz in your html area.
  60
  61 Nelson Ferreira <njsf@sxemacs.org>
  62
  63
  64 pop3.el.patch:
  65 -------------
  66 This patch is meant to be applied to pop3.el from the mail-lib package.
  67
  68 This patch provides SSL/TLS support for Gnus based on SXEmacs' native
  69 OpenSSL interface.  It works with the stream types 'ssl and 'starttls,
  70 so mail-sources already using one of these stream types will just keep
  71 on working.
  72
  73 An example mail source for a POP3 TLS connection:
  74
  75         (pop :server "some.pop3.server.tld"
  76              :user "me"
  77              :password "verysecret"
  78              :stream starttls)
  79
  80 An example mail source for a POP3s server:
  81
  82         (pop :server "some.pop3s.server.tld"
  83              :user "anotherme"
  84              :password "verysecret"
  85              :port 995
  86              :stream 'ssl)
  87
  88 The provided functionality has drop-in behaviour, so anything that worked
  89 before will keep on working.
  90
  91 Sebastian Freundt <hroptatyr@sxemacs.org>
  92
  93
  94 report-build-failure.sh:
  95 -----------------------
  96 Send an email to the SXEmacs developers mailing list with the details
  97 needed to troubleshoot failures to build SXEmacs.
  98
  99 The script requires your email address.
 100
 101 Usage: contrib/report-build-failure.sh superhacker@sxemacs.org
 102
 103 When tla is available the script will find the branch and closeness to
 104 the main branch as well as uncommitted changes.
 105
 106 Nelson Ferreira <njsf@sxemacs.org>
 107
 108
 109 show-tty-256-color.pl:
 110 ----------------------
 111 This script is from the X distribution and outputs a 6x6x6 color cube
 112 as well as a grayscale ramp consistent with the default 256 color xterm
 113 settings.
 114 You can use it to see if your terminal is capable of showing 256 colors.
 115
 116 Todd Larason <jtl@molehill.org>
 117
 118
 119 smtpmail.el.patch:
 120 -----------------
 121 This patch is meant to be applied to smtpmail.el from the mail-lib
 122 package.
 123
 124 This patch provides SSL/TLS support for smtp connections using SXEmacs'
 125 native OpenSSL interface.  It works out of the box with the usual
 126 credential definitions.
 127
 128 Additionally extends the smtpmail-starttls-credentials specifications by
 129 another argument, the fifth one, which can be a certificate authority's
 130 certificate file.  If specified the server must present a valid
 131 certificate signed by or verifiably by the certificate authority.
 132
 133 An example credential:
 134
 135         (setq smtpmail-starttls-credentials
 136               '(("some.smtp.server.tld" 25      ;; server+port
 137                  "~/.certs/my.smtpd.key"        ;; the cert's secret key
 138                  "~/.certs/my.smtpd.cert"       ;; the public cert
 139                  "~/.certs/smtp.server.ca"      ;; server's ca cert
 140                 )))
 141
 142 Sebastian Freundt <hroptatyr@sxemacs.org>
 143
 144 starttls.el.patch:
 145 -----------------
 146 This patch is meant to be applied to starttls.el from the mail-lib
 147 package.
 148
 149 This patch provides some basic SSL/TLS functionality used by other stuff
 150 in the mail-lib package.  Basically it just pretends to be Josefsson's
 151 starttls.el.  Instead of calling the gnutls binary externally the
 152 internal OpenSSL API functions are used.
 153
 154 Sebastian Freundt <hroptatyr@sxemacs.org>
 155
 156 tar-build-failure.sh
 157 --------------------
 158 Script that creates a tar file withe the contents that would also
 159 be emailed by report-build-failure.sh
 160
 161 Nelson Ferreira <njsf@sxemacs.org>
 162
 163
 164 tty-colors.c
 165 ------------
 166 C program using the curses library that detects the number of colors,
 167 the code sequences and can show the available colormap.
 168 Compile with:
 169         gcc -o tty-colors tty-colors.c -lncurses
 170 Invoke with:
 171        -m       Do a colormap
 172        -c       Do all foreground/background color combinations
 173        -f       Force the output of the basic ansi colors
 174        -s       Force the use of standout code
 175        -bs      Force the use of both bold and standout codes
 176        -q       Try to query the color map from the terminal
 177
 178 Nelson Ferreira <njsf@sxemacs.org>