source: branches/lib/HELP_SOURCE/source/save.hlp

Last change on this file was 19575, checked in by westram, 3 weeks ago
  • reintegrates 'help' into 'trunk'
    • preformatted text gets checked for width now (to enforce it fits into the arb help window).
    • fixed help following these checks, using the following steps:
      • ignore problems in foreign documentation.
      • increase default help window width.
      • introduce control comments to
        • accept oversized preformatted sections.
        • enforce preformatted style for whole sections.
        • simply define single-line preformatted sections
          Used intensive for definition of internal script languages.
    • fixed several non-related problems found in documentation.
    • minor layout changes for HTML version of arb help (more compacted; highlight anchored/all sections).
    • refactor system interface (GUI version) and use it from help module.
  • adds: log:branches/help@19532:19574
  • Property svn:eol-style set to native
  • Property svn:keywords set to Author Date Id Revision
File size: 4.1 KB
Line 
1#       main topics:
2UP      arb.hlp
3UP      glossary.hlp
4
5#       sub topics:
6
7# format described in ../help.readme
8
9
10TITLE           Save Database
11
12OCCURRENCE      ARB_NT/File/Quicksave changes
13                ARB_NT/File/Save whole database as ...
14                ARB_NT/<file icons in top area>
15                ARB_NT/<button with database name in top area> (read WARNINGS!)
16                ARB_MERGE/Save whole target DB as ...
17                ARB_MERGE/Quick-save changes of target DB
18                ARB_MERGE/File/Save source DB ...
19                ARB_EDIT4/File/Quicksave changes
20                ARB_EDIT4/File/Save whole database as ...
21
22DESCRIPTION     To save the entire database, choose 'Save whole database as ...'
23                from the 'File' menu of the 'ARB_NT' window.
24
25                Select or enter the filename as which your database should be saved.
26
27                Select the database type:
28
29                        * Binary (recommended, reasonable sequence compression)
30                        * Binary+Fastload (uses a huge file to speedup loading database into ARB; whether there
31                          really is some speedup depends on your system and machine, try it out)
32                        * Ascii (human-readable; extra HUGE)
33
34                Select extra compression:
35
36                        * None (compatible with arb 6.0.x and older)
37                        * otherwise ARB uses the selected command line compressor (like gzip, bzip2, xz)
38                          to compress the database during save. When loading a database, arb detects
39                          if a database is extra-compressed and automatically selects the correct
40                          decompressor.
41
42                          Note: you may rename an extra-compressed .arb file into .arb.gz or .arb.bz2
43                          before giving it away to a pre-arb-6.0 user. He will be able to open it using
44                          an archive manager and extract the contained .arb manually.
45
46SECTION         Quicksaving
47
48                You may also save only the changes done to the database,
49                using 'Quicksave changes' or 'Quicksave changes as' (accessible
50                via the DB name button in the ARB_NT top area).
51
52                        'Quicksave changes' saves all changes to the database
53                        'data.arb' to a file 'data.aXX' where XX is a numbered from
54                        01 to 99 and 00 (means 100).
55
56                        This is normally much faster than saving the entire database and
57                        results in much less disc consumption.
58
59                        Each time you save your changes, XX is increased by one.
60                        The last 10 data.aXX do not get deleted instantly, allowing you to
61                        step back to an older state.
62
63                        All data.aXX are independent and you may delete old changes
64                        files without losing data (as long as the latest is unchanged).
65
66                When you start arb you can choose among the different files:
67
68                         enter 'arb filename.arb' to search and load the latest changes,
69
70                         enter 'arb filename.aXX' to load a user-defined version.
71
72NOTES           Loading a specific quick save is also possible from the ARB INTRO window.
73                To do so, enter '*' as suffix.
74
75                Some database changes would cause huge-size quick-save files.
76                Therefore ARB disables the ability to quick-save the database after
77                several operations (e.g. when changing the order of database entries).
78                If you try to quick-save, you will get an error message.
79
80                In ARB_MERGE, saving will be disabled
81                  * for target database (when called via LINK{arb_merge_into.hlp})
82                  * for source database (when called via LINK{arb_merge_outof.hlp})
83
84WARNINGS        Using 'Quicksave changes as' is quite special. In that case the original
85                database gets locked (i.e. cannot be saved). Don't use that feature if
86                you don't understand what that means.
87
88BUGS            Hopefully no real bugs.
Note: See TracBrowser for help on using the repository browser.