aboutsummaryrefslogtreecommitdiff
path: root/GUIDELINES
blob: 92dfc6293458216c2de31e95cb7a8ad92d3f8bf6 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
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_LIST_PATH
    VERSION
    LINES
    FROM
    FROMADD
    DATE
    SUBJECT
    EMAIl (mudar para lowercase?)

    CONFIG
    CONFIG_PATH
    CONFIG_FILE

    DESCRIPTION

    GPGFLAGS
    GPGCOMMAND
    GPGLIST
    GPGDECRYPT
    GPGENCRYPT

    KEYID

  - variaveis auxiliares: x, n, signal

  - arrays

    ver USED_ARRAYS
    ADMINCOMMANDS

- Comandos Unix:

   $MAIL
   $GPG

   echo
   cat
   grep
   wc
   tr
   cut
   sed
   mkdir
   touch
   chmod
   basename
   expect