Projet

Général

Profil

Révision 09b88141

ID09b88141b34940d100df10b95b60206979e9df17
Parent 384d482f
Enfant 3a2f2ec7

Ajouté par Lars Kruse il y a environ 5 ans

Improve documantion of many plugins

Specifically the configuration examples are now indented properly.

Voir les différences:

plugins/router/arris-tg3442
12 12

  
13 13

  
14 14
=head1 REQUIREMENTS
15
- BeautifulSoup
16
- pycryptodome
15

  
16
=over 4
17

  
18
=item BeautifulSoup
19

  
20
=item pycryptodome
21

  
22
=back
17 23

  
18 24

  
19 25
=head1 CONFIGURATION
20 26

  
21 27
=head2 Example
22
[arris]
23
env.url http://192.168.100.1
24
env.username admin
25
env.password yourpassword
28

  
29
 [arris]
30
 env.url http://192.168.100.1
31
 env.username admin
32
 env.password yourpassword
26 33

  
27 34

  
28 35
=head2 Parameters
36

  
29 37
url      - URL to web-frontend
30 38
username - defaults to "admin"
31 39
password - valid password
......
37 45

  
38 46
=head1 AUTHOR
39 47

  
40
 Copyright (c) 2019 Daniel Hiepler <d-munin@coderdu.de>
41
 Copyright (c) 2004-2009 Nicolas Stransky <Nico@stransky.cx>
42
 Copyright (c) 2018 Lars Kruse <devel@sumpfralle.de>
48
Copyright (c) 2019 Daniel Hiepler <d-munin@coderdu.de>
49

  
50
Copyright (c) 2004-2009 Nicolas Stransky <Nico@stransky.cx>
51

  
52
Copyright (c) 2018 Lars Kruse <devel@sumpfralle.de>
43 53

  
44 54

  
45 55
=head1 LICENSE
46
 Permission to use, copy, and modify this software with or without fee
47
 is hereby granted, provided that this entire notice is included in
48
 all source code copies of any software which is or includes a copy or
49
 modification of this software.
50

  
51
 THIS SOFTWARE IS BEING PROVIDED "AS IS", WITHOUT ANY EXPRESS OR
52
 IMPLIED WARRANTY. IN PARTICULAR, NONE OF THE AUTHORS MAKES ANY
53
 REPRESENTATION OR WARRANTY OF ANY KIND CONCERNING THE
54
 MERCHANTABILITY OF THIS SOFTWARE OR ITS FITNESS FOR ANY PARTICULAR
55
 PURPOSE.
56

  
57
Permission to use, copy, and modify this software with or without fee
58
is hereby granted, provided that this entire notice is included in
59
all source code copies of any software which is or includes a copy or
60
modification of this software.
61

  
62
THIS SOFTWARE IS BEING PROVIDED "AS IS", WITHOUT ANY EXPRESS OR
63
IMPLIED WARRANTY. IN PARTICULAR, NONE OF THE AUTHORS MAKES ANY
64
REPRESENTATION OR WARRANTY OF ANY KIND CONCERNING THE
65
MERCHANTABILITY OF THIS SOFTWARE OR ITS FITNESS FOR ANY PARTICULAR
66
PURPOSE.
56 67

  
57 68

  
58 69
=head1 MAGIC MARKERS

Formats disponibles : Unified diff