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