Imported Upstream version 2.5.1
[debian/amanda] / docs / index.txt
1
2 The Official AMANDA Documentation
3                              Next
4
5 -------------------------------------------------------------------------------
6
7
8 The Official AMANDA Documentation
9
10
11 Edited by
12
13
14 Stefan G. Weichinger
15
16
17 Amanda Core Team
18
19 -------------------------------------------------------------------------------
20 Table of Contents
21
22
23   Abstract
24
25   Copyright_Information
26
27   Attributions
28
29   I._Installation
30
31
32         1._Amanda_2.5.0_-_System-Specific_Installation_Notes
33
34
35               Solaris_2.6
36
37               Solaris
38
39               Trusted_Solaris
40
41               SunOS_4.x
42
43               Ultrix
44
45               HP/UX
46
47               Linux
48
49               Digital_Unix_4
50
51               Sinix_5.43_(Reliant_Unix)
52
53               IRIX_(all)
54
55               IRIX_6
56
57               IRIX_6.5.x
58
59               SCO
60
61               FreeBSD_3.0
62
63               FreeBSD_4.9
64
65               FreeBSD_5.1
66
67               AIX
68
69               Microsoft_Windows
70
71               Mac_OS_X
72
73
74         2._Amanda_Installation_Notes
75
76
77               Before_doing_anything
78
79               Compiling_the_Amanda_sources
80
81               Setting_up_your_Amanda_Configuration
82
83
84                     Setting_up_the_Tape_Server_Host
85
86                     Set_up_the_Backup_Client_Hosts
87
88
89
90         3._Excluding
91
92
93               Introduction
94
95               Please_Read
96
97               Before_We_Begin
98
99               Choosing_an_exclude_mechanism
100
101
102                     Exclude_Mechanisms
103
104
105               Expression
106
107               Wildcard_Expansion
108
109               Troubleshooting
110
111
112                     Broken_gnutar?
113
114                     The_ps_command_is_your_friend.
115
116
117
118         4._Indexing_with_Amanda
119
120
121               Database_Format
122
123               Database_Browsing
124
125               File_Extraction
126
127               Protocol_Between_amindexd_and_amrecover
128
129               Installation_Notes
130
131               Permissions
132
133               Changes_from_amindex-1.0
134
135               Changes_from_amindex-0.3
136
137               Changes_from_amindex-0.2
138
139               Changes_from_amindex-0.1
140
141               Changes/additions_to_2.3.0
142
143               Known_Bugs
144
145
146         5._Backup_PC_hosts_using_Samba
147
148
149               Installation
150
151               Setup
152
153               Example
154
155               Bugs_and_notes
156
157
158         6._Restore
159
160
161   II._About_Tapes_and_Changers
162
163
164         7._Tapetypes
165
166         8._Amanda_Tape_Changer_Support
167
168
169               Introduction
170
171               Specifying_a_tape_changer_in_amanda.conf
172
173               Device-specific_tapechanger_script
174
175               Slot_names_and_the_"current"_slot
176
177               Operator_interface
178
179               How_amdump_interacts_with_the_tape_changer
180
181               Builtin_tape-changers
182
183
184                     chg-multi_(formerly_chg-generic)
185
186                     chg-manual_(formerly_no-changer)
187
188                     chg-mtx_(formerly_hp-changer)
189
190                     chg-zd-mtx
191
192                     chg-scsi-chio_(formerly_seagate-changer,_then_chg-chio)
193
194                     chg-scsi_(new_interface,_try_to_drive_a_robot_with_direct
195                     scsi_commands)
196
197                     chg-chio
198
199                     chg-chs
200
201                     chg-rth
202
203                     chg-juke
204
205                     chg-rait
206
207                     chg-disk
208
209                     chg-iomega
210
211                     chg-null
212
213
214
215         9._chg-scsi
216
217
218               Command_line_options
219
220               Notes_about_changer.conf
221
222               Amanda's_actual_usage_of_chg-scsi
223
224               Configuration_notes
225
226               Hacking_notes
227
228
229         10._RAIT_(Redundant_Array_of_Inexpensive_Tape)_Support
230
231
232               What_is_a_RAIT?
233
234               Using_a_RAIT
235
236               Disaster_Recovery
237
238
239         11._Printing_of_Labels
240
241
242               The_New_Feature
243
244               Labels_provided
245
246               History
247
248               How_it_works
249
250
251
252   III._HOWTOs
253
254
255         12._Amanda_on_Cygwin_HOWTO
256
257
258               Install_Cygwin
259
260               Other_Preparation
261
262               Compile_Amanda
263
264               Configure_Cygwin_files
265
266               Configure_Windows_System_Files
267
268               Configure_inetd_to_run_automatically_as_a_service
269
270               Windows_98/ME
271
272               Windows_NT/2000/XP
273
274               Notes_on_Amanda_backup_options
275
276
277                     Compression
278
279                     Exclude_Lists
280
281                     Debugging_Files
282
283
284
285         13._How_to_use_the_Amanda_file-driver
286
287
288               Introduction
289
290               Possible_Uses
291
292               Setup
293
294
295                     Basics
296
297
298               Recovery
299
300
301         14._AFS_HOWTO
302
303         15._How_to_use_a_wrapper
304
305
306               Bert_de_Ridder's_suggestions
307
308               Paul_Bijnens's_suggestions
309
310
311         16._How_to_do_Amanda-server-side_gpg-encrypted_backups.
312
313
314               Setup
315
316               Test
317
318               Plans
319
320
321         17._How_to_use_different_auth_with_Amanda
322
323
324               Introduction
325
326               BSD
327
328               BSDTCP
329
330               BSDUDP
331
332               KRB4
333
334               KRB5
335
336               RSH
337
338               SSH
339
340
341                     For_amdump:
342
343                     For_amrecover:
344
345
346
347
348   IV._Various_Information
349
350
351         18._Using_Amanda
352
353
354               An_Introduction
355
356               Amanda_Features
357
358               Future_Capabilities_of_Amanda
359
360               Amanda_Resources
361
362               Installing_Amanda
363
364
365                     Install_Related_Packages
366
367                     Perform_Preliminary_Setup
368
369                     Configure_the_Amanda_Build
370
371                     Build_and_Install_Amanda
372
373                     Configuring_Amanda
374
375                     Decide_on_a_Tape_Server
376
377                     Decide_Which_Tape_Devices_to_Use
378
379                     Decide_Whether_to_Use_Compression
380
381                     Decide_Where_the_Holding_Space_Will_Be
382
383                     Compute_Your_Dump_Cycle
384
385                     Copy_and_Edit_the_Default_Configuration_File
386
387                     Configure_the_Holding_Disk
388
389                     Configure_Tape_Devices_and_Label_Tapes
390
391                     Configure_Backup_Clients
392
393                     Test_and_Debug_Setup
394
395
396               Operating_Amanda
397
398
399                     Run_amdump
400
401                     Read_Amanda's_Reports
402
403                     Monitor_Tape_and_Holding_Disk_Status
404
405                     Adding_Tapes_at_a_Particular_Position_in_the_Cycle
406
407                     Miscellanous_Operational_Notes
408
409
410               Advanced_Amanda_Configuration
411
412
413                     Adjust_the_Backup_Cycle
414
415                     Adjust_Parallelism
416
417                     Monitor_for_Possible_Improvements
418
419                     Excluding_Files
420
421
422               Restoring_with_Amanda
423
424
425                     Configuring_and_Using_amrecover
426
427                     Using_amrestore
428
429                     Restoring_Without_Amanda
430
431
432
433         19._Amanda_FAQ
434
435         20._Collection_of_the_top_ten_Amanda_questions._And_answers.
436
437
438               Reason_for_starting_this_list.
439
440               the_DLE-question
441
442               the_localhost-question
443
444               the_friday-tape-question
445
446               the_multiple-dumps-question
447
448               the_mailing-list-question
449
450               the_distro-question
451
452               the_index-question
453
454               the_tapetype-questions
455
456               the_size-question
457
458               the_GUI-question
459
460               the_holding-disk_question
461
462               ...
463
464
465         21._Amanda_WISHLIST
466
467
468   V._Technical_Background
469
470
471         22._How_Amanda_uses_UDP_and_TCP_ports
472
473
474               TCP_port_allocation
475
476               User_TCP_port_range_(--with-tcpportrange)_summary
477
478               UDP_port_allocation
479
480               User_UDP_port_range_(--with-udpportrange)_summary
481
482               Firewalls_and_NAT
483
484
485         23._Amanda_dumper_API
486
487
488               Introduction
489
490               The_Problem
491
492               Overview_of_the_API
493
494
495                     The_`support'_command
496
497
498               The_`selfcheck'_command
499
500               The_`estimate'_and_`estimate-parse'_commands
501
502               The_`backup'_and_`backup-parse'_commands
503
504               The_`index-from-output'_and_`index-from-image'_commands
505
506               The_`restore'_command
507
508               The_`print-command'_command
509
510               Conclusion
511
512
513         24._Amanda_Internals
514
515
516               Protocols
517
518               server_and_amandad_on_client
519
520               planner_and_driver
521
522               driver_and_dumper
523
524               taper(read)_and_taper(write)
525
526
527         25._Amanda_Event_API
528
529
530               Introduction
531
532               The_API
533
534
535                     event_register
536
537                     event_release
538
539                     event_loop
540
541                     event_wait
542
543                     event_wakeup
544
545
546               Data_types
547
548
549                     event_handle_t
550
551                     event_id_t
552
553                     event_type_t
554
555                     event_fn_t
556
557
558               Event_Types
559
560
561                     EV_READFD
562
563                     EV_WRITEFD
564
565                     EV_SIG
566
567                     EV_TIME
568
569                     EV_WAIT
570
571
572
573         26._Amanda_Security_API
574
575
576               Introduction
577
578               The_Problem
579
580               The_API
581
582
583                     protocol_packet_transmission_functions
584
585                     stream_functions
586
587
588               Data_Types
589
590
591                     security_driver_t
592
593                     security_handle_t
594
595                     security_stream_t
596
597                     security_status_t
598
599
600               SECURITY_DRIVERS
601
602
603                     name
604
605                     connect
606
607                     accept
608
609                     close
610
611                     sendpkt
612
613                     recvpkt
614
615                     recvpkt_cancel
616
617                     stream_server
618
619                     stream_accept
620
621                     stream_client
622
623                     stream_close
624
625                     stream_auth
626
627                     stream_id
628
629                     stream_write
630
631                     stream_read
632
633                     stream_read_cancel
634
635
636
637         27._Virtual_Tape_API
638
639         28._Using_Kerberos_with_Amanda
640
641
642               Amanda_2.5.0_-_KERBEROS_v4_SUPPORT_NOTES
643
644
645                     Configuration
646
647                     Installation
648
649                     conf_file
650
651
652               Amanda_2.5.0_-_KERBEROS_v5_SUPPORT_NOTES
653
654
655                     Building
656
657                     Installation
658
659                     conf_file
660
661                     Destination_Host_Permissions_file
662
663
664
665
666   VI._Historical_files
667
668
669         29._Response_to_CPIO_Security_Notice_Issue_11:
670
671
672               Affected_Versions
673
674               Workaround
675
676               Acknowledgements
677
678
679         30._Upgrade_Issues
680
681         31._What_once_was_new
682
683
684               What's_new_in_Amanda_2.3
685
686
687                     Indexing_backups_for_easier_restore
688
689                     Samba_Support
690
691                     GnuTar_Support
692
693                     Multiple_backups_in_parallel_from_one_client_host
694
695                     Multiple_tapes_in_one_run
696
697                     Bottleneck_determination
698
699                     2_Gb_limit_removed
700
701                     amadmin_import/export
702
703
704               What's_new_in_Amanda_2.2
705
706
707                     Client_side_setup_has_changed
708
709                     Version_suffixes_on_executables
710
711                     Kerberos
712
713                     Multiple_holding_disks
714
715                     Remote_self-checks
716
717                     mmap_support
718
719                     gzip_support
720
721                     Mount_point_names_in_disklist
722
723                     Initial_tape-changer_support_included
724
725                     Generic_tape_changer_wrapper_script
726
727                     New_command_amtape
728
729                     Changer_support_added_to_command_amlabel
730
731                     Tape_changer_support_improved
732
733                     A_few_words_about_multi-tape_runs
734
735                     Big_planner_changes
736
737                     Level-0_dumps_allowed_with_no_tape
738
739
740
741         32._Multitape_support_in_Amanda_2.2
742
743
744               Introduction
745
746               New_Planner_Algorithm
747
748
749                     Time
750
751                     Full_Backups
752
753                     Schedule_Balancing
754
755                     Overwrite_Detection
756
757
758               Taper_Algorithm
759
760
761                     Choosing_a_tape
762
763                     End_of_tape_handling
764
765                     Tape_Format_Changes
766
767                     Tapelist_File_Changes
768
769
770
771         33._Thoughts_about_a_Strategy_API
772
773         34._Y2K_Compliancy
774
775         35._Usage_of_floppy_tape_drives_on_Linux
776
777
778   VII._Appendixes
779
780
781         36._The_Amanda_Manual_Pages.
782
783
784               amadmin - administrative interface to control Amanda backups
785
786               amaespipe - wrapper program for aespipe
787
788               amanda - Advanced Maryland Automatic Network Disk Archiver
789
790               amanda.conf - Main configuration file for Amanda, the Advanced
791               Maryland Automatic Network Disk Archiver
792
793               amanda-client.conf - Client configuration file for Amanda, the
794               Advanced Maryland Automatic Network Disk Archiver
795
796               amcheck - run Amanda self-checks
797
798               amcheckdb - check Amanda database for tape consistency
799
800               amcleanup - run the Amanda cleanup process after a failure
801
802               amcrypt - reference crypt program for Amanda symmetric data
803               encryption
804
805               amcrypt-ossl - crypt program for Amanda symmetric data encryption
806               using OpenSSL
807
808               amcrypt-ossl-asym - crypt program for Amanda asymmetric data
809               encryption using OpenSSL
810
811               amdd - Amanda version of dd
812
813               amdump - back up all disks in an Amanda configuration
814
815               amfetchdump - extract backup images from multiple Amanda tapes.
816
817               amflush - flush Amanda backup files from holding disk to tape
818
819               amgetconf - look up amanda.conf variables
820
821               amlabel - label an Amanda tape
822
823               ammt - Amanda version of mt
824
825               amoverview - display file systems processed by Amanda over time
826
827               amplot - visualize the behavior of Amanda
828
829               amrecover - Amanda index database browser
830
831               amreport - generate a formatted output of statistics for an
832               Amanda run
833
834               amrestore - extract backup images from an Amanda tape
835
836               amrmtape - remove a tape from the Amanda database
837
838               amstatus - display the state of an Amanda run
839
840               amtape - user interface to Amanda tape changer controls
841
842               amtapetype - generate a tapetype definition.
843
844               amtoc - generate TOC (Table Of Contents) for an Amanda run
845
846               amverify - check an Amanda tape for errors
847
848               amverifyrun - check the tapes written by the last Amanda run
849
850
851         37._Web_Ressources
852
853
854   Index
855
856 List of Tables
857
858
859   4.1. Protocol_between_amindexd_and_amrecover
860
861 List of Examples
862
863
864   2.1. /etc/crontab
865
866   2.2. /etc/services
867
868   2.3. /etc/inetd.conf
869
870   2.4. /etc/xinetd.d/amandaidx
871
872   2.5. /etc/xinetd.d/amidxtape
873
874   2.6. /etc/amanda/supervise/amandaidx/run
875
876   2.7. /etc/amanda/supervise/amidxtape/run
877
878   2.8. /etc/services
879
880   2.9. /etc/inetd.conf
881
882   2.10. /etc/xinetd.d/amanda
883
884   2.11. /etc/amanda/supervise/amanda/run
885
886   15.1.
887
888   15.2.
889
890   16.1. /usr/local/libexec/amgtar
891
892   16.2. /usr/local/bin/amaespipe
893
894   16.3. bz2aespipe.patch
895
896   18.1. A_C_Program_to_Check_the_Amanda_Service_Numbers
897
898 -------------------------------------------------------------------------------
899
900          Next
901      Abstract
902