← Back to branch summary

~ubuntu-branches/debian/squeeze/erlang/squeeze

« back to all changes in this revision

Viewing changes to lib/snmp/doc/src/snmpa_conf.xml

  • Committer: Bazaar Package Importer
  • Author(s): Sergei Golovan
  • Date: 2009-08-05 20:54:29 UTC
  • mfrom: (6.1.2 sid)
  • Revision ID: james.westby@ubuntu.com-20090805205429-pm4pnwew8axraosl
Tags: 1:13.b.1-dfsg-5
http://bugs.debian.org/536891
* Fixed parentheses in Emacs mode (closes: #536891).
* Removed unnecessary conflicts with erlang-manpages package.
* Added workaround for #475459: disabled threads on sparc architecture.
  This breaks wxErlang, so it's only a temporary solution.

Show diffs side-by-side

added added

removed removed

Lines of Context:
lib/snmp/doc/src/snmpa_conf.xml
37
37
    <p>The module <c>snmpa_conf</c> contains various utility functions to 
38
38
      used for manipulating (write/append/read) the config files of the
39
39
      SNMP agent. </p>
 
40
 
40
41
    <marker id="agent_entry"></marker>
41
42
  </description>
42
43
  <funcs>
54
55
          see 
55
56
          <seealso marker="snmp_agent_config_files#agent_information">Agent Information</seealso> 
56
57
          for more info. </p>
 
58
 
57
59
        <marker id="write_agent_config"></marker>
58
60
      </desc>
59
61
    </func>
 
62
 
60
63
    <func>
61
64
      <name>write_agent_config(Dir, Conf) -> ok</name>
62
65
      <name>write_agent_config(Dir, Hdr, Conf) -> ok</name>
75
78
        <p>See 
76
79
          <seealso marker="snmp_agent_config_files#agent_information">Agent Information</seealso> 
77
80
          for more info. </p>
 
81
 
78
82
        <marker id="append_agent_config"></marker>
79
83
      </desc>
80
84
    </func>
 
85
 
81
86
    <func>
82
87
      <name>append_agent_config(Dir, Conf) -> ok</name>
83
88
      <fsummary>Append the agent config to the config file</fsummary>
92
97
        <p>See 
93
98
          <seealso marker="snmp_agent_config_files#agent_information">Agent Information</seealso> 
94
99
          for more info. </p>
 
100
 
95
101
        <marker id="read_agent_config"></marker>
96
102
      </desc>
97
103
    </func>
 
104
 
98
105
    <func>
99
106
      <name>read_agent_config(Dir) -> Conf</name>
100
107
      <fsummary>Read the agent config from the config file</fsummary>
109
116
        <p>See 
110
117
          <seealso marker="snmp_agent_config_files#agent_information">Agent Information</seealso> 
111
118
          for more info. </p>
 
119
 
112
120
        <marker id="standard_entry"></marker>
113
121
      </desc>
114
122
    </func>
 
123
 
115
124
    <func>
116
125
      <name>standard_entry(Tag, Val) -> standard_entry()</name>
117
126
      <fsummary>Create an standard entry</fsummary>
127
136
          see 
128
137
          <seealso marker="snmp_agent_config_files#system_information">System Information</seealso> 
129
138
          for more info. </p>
 
139
 
130
140
        <marker id="write_standard_config"></marker>
131
141
      </desc>
132
142
    </func>
 
143
 
133
144
    <func>
134
145
      <name>write_standard_config(Dir, Conf) -> ok</name>
135
146
      <name>write_standard_config(Dir, Hdr, Conf) -> ok</name>
149
160
        <p>See 
150
161
          <seealso marker="snmp_agent_config_files#system_information">System Information</seealso> 
151
162
          for more info. </p>
 
163
 
152
164
        <marker id="append_standard_config"></marker>
153
165
      </desc>
154
166
    </func>
 
167
 
155
168
    <func>
156
169
      <name>append_standard_config(Dir, Conf) -> ok</name>
157
170
      <fsummary>Append the agent standard config to the config file</fsummary>
167
180
        <p>See 
168
181
          <seealso marker="snmp_agent_config_files#system_information">System Information</seealso> 
169
182
          for more info. </p>
 
183
 
170
184
        <marker id="read_standard_config"></marker>
171
185
      </desc>
172
186
    </func>
 
187
 
173
188
    <func>
174
189
      <name>read_standard_config(Dir) -> Conf</name>
175
190
      <fsummary>Read the agent standard config from the config file</fsummary>
184
199
        <p>See 
185
200
          <seealso marker="snmp_agent_config_files#system_information">System Information</seealso> 
186
201
          for more info. </p>
 
202
 
187
203
        <marker id="context_entry"></marker>
188
204
      </desc>
189
205
    </func>
 
206
 
190
207
    <func>
191
208
      <name>context_entry(Context) -> context_entry()</name>
192
209
      <fsummary>Create an context entry</fsummary>
200
217
        <p>See 
201
218
          <seealso marker="snmp_agent_config_files#context">Contexts</seealso> 
202
219
          for more info. </p>
 
220
 
203
221
        <marker id="write_context_config"></marker>
204
222
      </desc>
205
223
    </func>
 
224
 
206
225
    <func>
207
226
      <name>write_context_config(Dir, Conf) -> ok</name>
208
227
      <name>write_context_config(Dir, Hdr, Conf) -> ok</name>
222
241
        <p>See 
223
242
          <seealso marker="snmp_agent_config_files#context">Contexts</seealso> 
224
243
          for more info. </p>
 
244
 
225
245
        <marker id="append_context_config"></marker>
226
246
      </desc>
227
247
    </func>
 
248
 
228
249
    <func>
229
250
      <name>append_context_config(Dir, Conf) -> ok</name>
230
251
      <fsummary>Append the agent context(s) to the config file</fsummary>
240
261
        <p>See 
241
262
          <seealso marker="snmp_agent_config_files#context">Contexts</seealso> 
242
263
          for more info. </p>
 
264
 
243
265
        <marker id="read_context_config"></marker>
244
266
      </desc>
245
267
    </func>
 
268
 
246
269
    <func>
247
270
      <name>read_context_config(Dir) -> Conf</name>
248
271
      <fsummary>Read the agent context config from the config file</fsummary>
257
280
        <p>See 
258
281
          <seealso marker="snmp_agent_config_files#context">Contexts</seealso> 
259
282
          for more info. </p>
 
283
 
260
284
        <marker id="community_entry"></marker>
261
285
      </desc>
262
286
    </func>
 
287
 
263
288
    <func>
264
289
      <name>community_entry(CommunityIndex) -> community_entry()</name>
265
290
      <name>community_entry(CommunityIndex, CommunityName, SecName, ContextName, TransportTag) -> community_entry()</name>
283
308
        <p>See 
284
309
          <seealso marker="snmp_agent_config_files#community">Community</seealso> 
285
310
          for more info. </p>
 
311
 
286
312
        <marker id="write_community_config"></marker>
287
313
      </desc>
288
314
    </func>
 
315
 
289
316
    <func>
290
317
      <name>write_community_config(Dir, Conf) -> ok</name>
291
318
      <name>write_community_config(Dir, Hdr, Conf) -> ok</name>
305
332
        <p>See 
306
333
          <seealso marker="snmp_agent_config_files#community">Community</seealso> 
307
334
          for more info. </p>
 
335
 
308
336
        <marker id="append_community_config"></marker>
309
337
      </desc>
310
338
    </func>
 
339
 
311
340
    <func>
312
341
      <name>append_community_config(Dir, Conf) -> ok</name>
313
342
      <fsummary>Append the agent community config to the config file</fsummary>
323
352
        <p>See 
324
353
          <seealso marker="snmp_agent_config_files#community">Community</seealso> 
325
354
          for more info. </p>
 
355
 
326
356
        <marker id="read_community_config"></marker>
327
357
      </desc>
328
358
    </func>
 
359
 
329
360
    <func>
330
361
      <name>read_community_config(Dir) -> Conf</name>
331
362
      <fsummary>Read the agent community config from the config file</fsummary>
340
371
        <p>See 
341
372
          <seealso marker="snmp_agent_config_files#community">Communities</seealso> 
342
373
          for more info. </p>
 
374
 
343
375
        <marker id="target_addr_entry"></marker>
344
376
      </desc>
345
377
    </func>
 
378
 
346
379
    <func>
347
380
      <name>target_addr_entry(Name, Ip, TagList, ParamsName, EngineId) -> target_addr_entry()</name>
348
381
      <name>target_addr_entry(Name, Ip, TagList, ParamsName, EngineId, TMask) -> target_addr_entry()</name>
375
408
        <p>See 
376
409
          <seealso marker="snmp_agent_config_files#target_addr">Target Address Definitions</seealso> 
377
410
          for more info. </p>
 
411
 
378
412
        <marker id="write_target_addr_config"></marker>
379
413
      </desc>
380
414
    </func>
 
415
 
381
416
    <func>
382
417
      <name>write_target_addr_config(Dir, Conf) -> ok</name>
383
418
      <name>write_target_addr_config(Dir, Hdr, Conf) -> ok</name>
397
432
        <p>See 
398
433
          <seealso marker="snmp_agent_config_files#target_addr">Target Address Definitions</seealso> 
399
434
          for more info. </p>
 
435
 
400
436
        <marker id="append_target_addr_config"></marker>
401
437
      </desc>
402
438
    </func>
 
439
 
403
440
    <func>
404
441
      <name>append_target_addr_config(Dir, Conf) -> ok</name>
405
442
      <fsummary>Append the agent target_addr config to the config file</fsummary>
415
452
        <p>See 
416
453
          <seealso marker="snmp_agent_config_files#target_addr">Target Address Definitions</seealso> 
417
454
          for more info. </p>
 
455
 
418
456
        <marker id="read_target_addr_config"></marker>
419
457
      </desc>
420
458
    </func>
 
459
 
421
460
    <func>
422
461
      <name>read_target_addr_config(Dir) -> Conf</name>
423
462
      <fsummary>Read the agent target_addr config from the config file</fsummary>
432
471
        <p>See 
433
472
          <seealso marker="snmp_agent_config_files#target_addr">Target Address Definitions</seealso> 
434
473
          for more info. </p>
 
474
 
435
475
        <marker id="target_params_entry"></marker>
436
476
      </desc>
437
477
    </func>
 
478
 
438
479
    <func>
439
480
      <name>target_params_entry(Name, Vsn) -> target_params_entry()</name>
440
481
      <name>target_params_entry(Name, Vsn, SecName, SecLevel) -> target_params_entry()</name>
467
508
        <p>See 
468
509
          <seealso marker="snmp_agent_config_files#target_params">Target Parameters Definitions</seealso> 
469
510
          for more info. </p>
 
511
 
470
512
        <marker id="write_target_params_config"></marker>
471
513
      </desc>
472
514
    </func>
 
515
 
473
516
    <func>
474
517
      <name>write_target_params_config(Dir, Conf) -> ok</name>
475
518
      <name>write_target_params_config(Dir, Hdr, Conf) -> ok</name>
489
532
        <p>See 
490
533
          <seealso marker="snmp_agent_config_files#target_params">Target Parameters Definitions</seealso> 
491
534
          for more info. </p>
 
535
 
492
536
        <marker id="append_target_params_config"></marker>
493
537
      </desc>
494
538
    </func>
 
539
 
495
540
    <func>
496
541
      <name>append_target_params_config(Dir, Conf) -> ok</name>
497
542
      <fsummary>Append the agent target_params config to the config file</fsummary>
507
552
        <p>See 
508
553
          <seealso marker="snmp_agent_config_files#target_params">Target Parameters Definitions</seealso> 
509
554
          for more info. </p>
 
555
 
510
556
        <marker id="read_target_params_config"></marker>
511
557
      </desc>
512
558
    </func>
 
559
 
513
560
    <func>
514
561
      <name>read_target_params_config(Dir) -> Conf</name>
515
562
      <fsummary>Read the agent target_params config from the config file</fsummary>
524
571
        <p>See 
525
572
          <seealso marker="snmp_agent_config_files#target_params">Target Parameters Definitions</seealso> 
526
573
          for more info. </p>
 
574
 
527
575
        <marker id="vacm_entry"></marker>
528
576
      </desc>
529
577
    </func>
 
578
 
530
579
    <func>
531
580
      <name>vacm_s2g_entry(SecModel, SecName, GroupName) -> vacm_s2g_entry()</name>
532
581
      <name>vacm_acc_entry(GroupName, Prefix, SecModel, SecLevel, Match, ReadView, WriteView, NotifyView) -> vacm_acc_entry()</name>
560
609
        <p>See 
561
610
          <seealso marker="snmp_agent_config_files#vacm">MIB Views for VACM</seealso> 
562
611
          for more info. </p>
 
612
 
563
613
        <marker id="write_vacm_config"></marker>
564
614
      </desc>
565
615
    </func>
 
616
 
566
617
    <func>
567
618
      <name>write_vacm_config(Dir, Conf) -> ok</name>
568
619
      <name>write_vacm_config(Dir, Hdr, Conf) -> ok</name>
583
634
        <p>See 
584
635
          <seealso marker="snmp_agent_config_files#vacm">MIB Views for VACM</seealso> 
585
636
          for more info. </p>
 
637
 
586
638
        <marker id="append_vacm_config"></marker>
587
639
      </desc>
588
640
    </func>
 
641
 
589
642
    <func>
590
643
      <name>append_vacm_config(Dir, Conf) -> ok</name>
591
644
      <fsummary>Append the agent vacm config to the config file</fsummary>
601
654
        <p>See 
602
655
          <seealso marker="snmp_agent_config_files#vacm">MIB Views for VACM</seealso> 
603
656
          for more info. </p>
 
657
 
604
658
        <marker id="read_vacm_config"></marker>
605
659
      </desc>
606
660
    </func>
 
661
 
607
662
    <func>
608
663
      <name>read_vacm_config(Dir) -> Conf</name>
609
664
      <fsummary>Read the agent vacm config from the config file</fsummary>
618
673
        <p>See 
619
674
          <seealso marker="snmp_agent_config_files#vacm">MIB Views for VACM</seealso> 
620
675
          for more info. </p>
 
676
 
621
677
        <marker id="usm_entry"></marker>
622
678
      </desc>
623
679
    </func>
 
680
 
624
681
    <func>
625
682
      <name>usm_entry(EngineId) -> usm_entry()</name>
626
683
      <name>usm_entry(EngineID, UserName, SecName, Clone, AuthP, AuthKeyC, OwnAuthKeyC, PrivP, PrivKeyC, OwnPrivKeyC, Public, AuthKey, PrivKey) -> usm_entry()</name>
649
706
        <p>See 
650
707
          <seealso marker="snmp_agent_config_files#usm">Security data for USM</seealso> 
651
708
          for more info. </p>
 
709
 
652
710
        <marker id="write_usm_config"></marker>
653
711
      </desc>
654
712
    </func>
 
713
 
655
714
    <func>
656
715
      <name>write_usm_config(Dir, Conf) -> ok</name>
657
716
      <name>write_usm_config(Dir, Hdr, Conf) -> ok</name>
671
730
        <p>See 
672
731
          <seealso marker="snmp_agent_config_files#usm">Security data for USM</seealso> 
673
732
          for more info. </p>
 
733
 
674
734
        <marker id="append_usm_config"></marker>
675
735
      </desc>
676
736
    </func>
 
737
 
677
738
    <func>
678
739
      <name>append_usm_config(Dir, Conf) -> ok</name>
679
740
      <fsummary>Append the agent usm config to the config file</fsummary>
692
753
        <marker id="read_usm_config"></marker>
693
754
      </desc>
694
755
    </func>
 
756
 
695
757
    <func>
696
758
      <name>read_usm_config(Dir) -> Conf</name>
697
759
      <fsummary>Read the agent usm config from the config file</fsummary>
706
768
        <p>See 
707
769
          <seealso marker="snmp_agent_config_files#usm">Security data for USM</seealso> 
708
770
          for more info. </p>
 
771
 
709
772
        <marker id="notify_entry"></marker>
710
773
      </desc>
711
774
    </func>
 
775
 
712
776
    <func>
713
777
      <name>notify_entry(Name, Tag, Type) -> notify_entry()</name>
714
778
      <fsummary>Create an notify entry</fsummary>
725
789
        <p>See 
726
790
          <seealso marker="snmp_agent_config_files#notify">Notify Definitions</seealso> 
727
791
          for more info. </p>
 
792
 
728
793
        <marker id="write_notify_config"></marker>
729
794
      </desc>
730
795
    </func>
 
796
 
731
797
    <func>
732
798
      <name>write_notify_config(Dir, Conf) -> ok</name>
733
799
      <name>write_notify_config(Dir, Hdr, Conf) -> ok</name>
747
813
        <p>See 
748
814
          <seealso marker="snmp_agent_config_files#notify">Notify Definitions</seealso> 
749
815
          for more info. </p>
 
816
 
750
817
        <marker id="append_notify_config"></marker>
751
818
      </desc>
752
819
    </func>
 
820
 
753
821
    <func>
754
822
      <name>append_notify_config(Dir, Conf) -> ok</name>
755
823
      <fsummary>Append the agent notify config to the config file</fsummary>
765
833
        <p>See 
766
834
          <seealso marker="snmp_agent_config_files#notify">Notify Definitions</seealso> 
767
835
          for more info. </p>
 
836
 
768
837
        <marker id="read_notify_config"></marker>
769
838
      </desc>
770
839
    </func>
 
840
 
771
841
    <func>
772
842
      <name>read_notify_config(Dir) -> Conf</name>
773
843
      <fsummary>Read the agent notify config from the config file</fsummary>