changes for firma rev 1.31

1 files changed, 91 insertions, 80 deletions

diff --git a/GUIDELINES b/GUIDELINES
index b371ec5..c0ac0be 100755
--- a/GUIDELINES
+++ b/GUIDELINES
@@ -1,97 +1,107 @@
-Pequena politica de desenvolvimento pro firma
----------------------------------------------
-
-Intuito: ajudar no controle do desenvolvimento para
-         que o codigo nao estufe de lixo e que se mantenha seguro.
-
-Apos qualquer adicao no firma, efetue o seguinte procedimento
--------------------------------------------------------------
-
-  - Coloque as novas variaveis criadas na lista de variaveis
-  - Se a variavel for definida via arquivo de configuracao, adicione-a na
-    funcao newlist e na rotina de carregamento do arquivo de configuracao
-  - Coloque as novas funcoes criadas na lista de funcoes
-  - Coloque os novos arrays na variavei USED_ARRAYS
-  - Se estiver usando um comando unix, verifique se o mesmo jah estah listado
-    na lista de programas, caso contrario adicione-o
-
-Uso de variaveis
-----------------
-
-  - Variaves globais: uppercase
-  - Variaves locais a uma funcao ou rotina: lowercase, devem ser zeradas depois do uso
-  - Cuidado com a inicializacao, zerar tudo quando nao mais necessario
-
-Listagem
---------
-
-- funcoes utilizadas:
-
-  usage 
-  version 
-  check_config 
-  get_gpg_stderr 
-  get_subscribers_list 
-  get_message 
-  get_gpg_message 
-  get_message_headers 
-  message_list 
-  message_list_error 
-  message_list_return 
-  process_message 
-  newlist 
-  gpg_args 
-  list_admin 
-  choose_uid
-
-- variaveis utilizadas:
-
-  - via arquivo de configuracao
-
-    MAIL
-    MAIL_ARGS
-    GPG
-    LISTNAME
-    LISTADMIN
-    GPGDIR
-    PASSWD
-
-  - direto no script
+Firma development policy
+------------------------
+
+Abstract: this policy helps control all development
+          steps to keep a clean and junk-free code.
+
+In the future this procedure will be automatic.
+
+1 - After any adition to firma, check the following:
+----------------------------------------------------
+
+  - Put all new variables in the variables list
+  - If the new var is used via config-file, add its creation
+    in the function 'newlist'
+  - Put all new functions in the function list 
+  - Put all new arrays in var USED_ARRAYS
+  - If you are using an unix command, check if its already
+    listed in the command list, if not please add it
+
+2 - Variables usage
+-------------------
+
+  - Global vars: uppercase
+  - Local vars: lowercase, declared with "local"
+  - Attention to variables initialization, unset all vars after use
+
+3 - Script listing
+------------------
+
+- used functions:
+
+  DeclareGpgVars 
+  Usage 
+  Version 
+  CheckFirmaConfigFile 
+  CheckListConfigFile 
+  GetMessage 
+  GetMessageHeaders 
+  GetGpgMessage 
+  GetGpgDecryptStderr 
+  GetSubscribersList 
+  SendListMessage 
+  SendWarningMessage 
+  SendBounceMessage 
+  ProcessMessage 
+  NewList 
+  ListAdministration 
+  ChooseUid 
+
+- used variables:
+
+  - via config file
+
+    GPG_BINARY
+    MAIL_AGENT
+    MAIL_AGENT_ARGS
+    LISTS_DIR 
+
+    LIST_ADDRESS
+    LIST_ADMIN
+    LIST_HOMEDIR
+    PASSPHRASE
+
+  - direct at firma
 
-    FIRMA_LIST_PATH
     VERSION
-    LINES
+
+    GPG
+    GPG_FLAGS
+    GPG_LIST_KEYS
+    GPG_DECRYPT
+    GPG_ENCRYPT
+
+    LISTS_DIR
+    SENDER_ADDRESS
+    ARRAY
+    LIST_NAME
+    LIST_PATH
+    LIST_CONFIG_FILE
+    FIRMA_CONFIG_FILE
+
     FROM
-    FROMADD
     DATE
     SUBJECT
-    EMAIl (mudar para lowercase?)
-
-    CONFIG
-    CONFIG_PATH
-    CONFIG_FILE
 
     DESCRIPTION
 
-    GPGFLAGS
-    GPGCOMMAND
-    GPGLIST
-    GPGDECRYPT
-    GPGENCRYPT
+  - local vars
 
-    KEYID
-
-  - variaveis auxiliares: count, n, signal
+    administrator
+    email
+    keyid
+    element, i, j, uid_count, chosen_uid_number
 
   - arrays
 
-    ver USED_ARRAYS
-    ADMINCOMMANDS
+    see GLOBAL_ARRAYS
+
+- unix commands:
 
-- Comandos Unix:
+   bash itself
 
-   $MAIL
-   $GPG
+   $GPG_BINARY
+   $MAIL_AGENT
 
    echo
    cat
@@ -106,3 +116,4 @@ Listagem
    chmod
    basename
    expect
+   fold