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