Welcome to little lamb

Code » anopa » jjk » tree

[jjk] / doc / anopa-rc.pod 

 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
=head1 RETURN CODES

Every command or utility in B<anopa> follows certain rules when it comes to
return codes. Return codes are classified under two categories, based on whether
the least significant bit (LSB) is set or not.

If the LSB is set, i.e. the return code is odd, it represents a fatal error. The
remaining 7bit integer is a fatal error code, common to all software in
B<anopa>.

If the LSB isn't set, i.e. the return code is even, it is an error code that is
specific to this command/utility. Although for easiness/consistency, all
commands do use the same ones, as described below.

=head2 Odd return codes: fatal errors

All commands & utilities in B<anopa> share the same fatal return codes, all
listed in the following table:

    +--------+-------+------------------------------+-----------------------+
    | return | 7-bit | Meaning                      | Notes                 |
    |  code  | value |                              |                       |
    +--------+-------+------------------------------+-----------------------+
    |    1   |    0  | Usage error                  |                       |
    +--------+-------+------------------------------+-----------------------+
    |    3   |    1  | Failed to init repository    | Only for commands     |
    +--------+-------+------------------------------+-----------------------+
    |    5   |    2  | I/O error                    |                       |
    +--------+-------+------------------------------+-----------------------+
    |    7   |    3  | Memory error                 |                       |
    +--------+-------+------------------------------+-----------------------+
    |  111   |   55  | Failed to exec               |                       |
    +--------+-------+------------------------------+-----------------------+
    |  255   |  127  | Internal error               | Shouldn't happen      |
    +--------+-------+------------------------------+-----------------------+

=head2 Even return codes

As explained, even return codes aren't common all through B<anopa>, though for
easiness & consistency all commands use the same ones. For even return codes of
utilities, please refer to its specific man page.

For commands (B<aa-start>(1), B<aa-stop>(1), B<aa-enable>(1), B<aa-status>(1),
B<aa-reset>(1)), the remaining 7bit integer is actually a bitwise combination
of the following flags :

    +------+------+-------------------------------------------+----------------+
    |  RC  | 7bit | Meaning                                   | Applies to:    |
    | flag | flag |                                           |                |
    +------+------+-------------------------------------------+----------------+
    |   2  |    1 | At least one service was unknown          | All            |
    +------+------+-------------------------------------------+----------------+
    |   4  |    2 | At least one service was skipped          | start/reset    |
    +------+------+-------------------------------------------+----------------+
    |   8  |    4 | At least one service failed               | All            |
    +------+------+-------------------------------------------+----------------+
    |  16  |    8 | At least one failed service was essential | start          |
    +------+------+-------------------------------------------+----------------+
    |  32  |   16 | At least one file copy failed (--set-*)   | enable         |
    +------+------+-------------------------------------------+----------------+
    |  64  |   32 | Failed to alarm s6-svscan                 | enable         |
    +------+------+-------------------------------------------+----------------+