From 17120fa54bac4b90a641ae520897f1286d07d58c Mon Sep 17 00:00:00 2001 From: Philipp Storz Date: Wed, 28 Nov 2018 14:19:48 +0100 Subject: [PATCH] fix bcommand --- docs/manuals/en/new_main_reference/replace.sh | 9 +- .../source/always-incremental.rst | 6 +- .../source/autochangers.rst | 14 +-- .../en/new_main_reference/source/bconsole.rst | 98 +++++++++---------- .../new_main_reference/source/bootstrap.rst | 2 +- .../source/catmaintenance.rst | 4 +- .../source/client-initiated-connection.rst | 4 +- .../new_main_reference/source/consoleconf.rst | 2 +- .../en/new_main_reference/source/dirdconf.rst | 16 +-- .../en/new_main_reference/source/disk.rst | 2 +- .../en/new_main_reference/source/ndmp.rst | 6 +- .../en/new_main_reference/source/programs.rst | 8 +- .../new_main_reference/source/quickstart.rst | 2 +- .../new_main_reference/source/recycling.rst | 20 ++-- .../source/releasenotes.rst | 24 ++--- .../en/new_main_reference/source/spooling.rst | 2 +- .../en/new_main_reference/source/tables.rst | 2 +- .../en/new_main_reference/source/tutorial.rst | 38 +++---- .../en/new_main_reference/source/webui.rst | 4 +- 19 files changed, 131 insertions(+), 132 deletions(-) diff --git a/docs/manuals/en/new_main_reference/replace.sh b/docs/manuals/en/new_main_reference/replace.sh index 547d87e029c..0863a7e2a54 100755 --- a/docs/manuals/en/new_main_reference/replace.sh +++ b/docs/manuals/en/new_main_reference/replace.sh @@ -46,6 +46,11 @@ sed -i 's#:raw-latex:`\\vSphere\(\s*\)`#\|vsphere\|\1#g' *.rst +perl -i -pe 's#:raw-latex:`\\bcommand\{(^[}]*)\}`#:strong:`1\1`#g' *.rst +perl -i -pe 's#:raw-latex:`\\bcommand\{(.*?)\}\{\}`#:strong:`2\1`#g' *.rst +perl -i -pe 's#:raw-latex:`\\bcommand\{(.*?)\}\{(.+?)}`#:strong:`3\1 \2`#g' *.rst + +perl -i -pe 's#\\bcommand\{(.*?)\}\{}#:strong:`\1`#g' *.rst perl -i -pe 's#:raw-latex:`\\command\{(.*?)\}`#:program:`\1`#g' *.rst @@ -172,10 +177,6 @@ perl -i -pe 's#\\variable\{(.*?)\}#:envvar:`\1`#g' *.rst #\dt perl -i -pe 's#:raw-latex:`\\dt\{([A-Za-z ]*)\}`#:strong:`\1`\ #g' *.rst -perl -i -pe 's#:raw-latex:`\\bcommand\{(.*?)\}\{(.*?)}`#:strong:`\1 \2`#g' *.rst -perl -i -pe 's#:raw-latex:`\\bcommand\{(.*?)\}\{\}`#:strong:`\1`#g' *.rst -perl -i -pe 's#:raw-latex:`\\bcommand\{(.*?)\}`#:strong:`\1`#g' *.rst - #\os perl -i -pe 's#\\os\{(.*?)\}\{}#:strong:`\1`#g' *.rst diff --git a/docs/manuals/en/new_main_reference/source/always-incremental.rst b/docs/manuals/en/new_main_reference/source/always-incremental.rst index 64df7defd5b..0b37b993f59 100644 --- a/docs/manuals/en/new_main_reference/source/always-incremental.rst +++ b/docs/manuals/en/new_main_reference/source/always-incremental.rst @@ -693,7 +693,7 @@ storage: | 1 | Full-0001 | Append | 1 | 38600329 | 0 | 31536000 | 1 | 0 | 0 | File | 2016-07-28 14:00:47 | File-remote | +---------+------------+-----------+---------+----------+----------+--------------+---------+------+-----------+-----------+---------------------+-------------+ -Use :strong:`update volume` to set the right storage and +Use :strong:`3update volume` to set the right storage and check with list volumes that it worked: @@ -737,10 +737,10 @@ case to make the incremental backups possible. - Configure the Job that should backup the remote client with the fileset. -- Run :strong:`estimate listing` on the remote backup +- Run :strong:`3estimate listing` on the remote backup job. -- Run :strong:`list filesets` to make sure the fileset +- Run :strong:`3list filesets` to make sure the fileset was added to the catalog. Then we need to create a backup on the remote machine onto a portable diff --git a/docs/manuals/en/new_main_reference/source/autochangers.rst b/docs/manuals/en/new_main_reference/source/autochangers.rst index 98634b72e92..9a723aaebd2 100644 --- a/docs/manuals/en/new_main_reference/source/autochangers.rst +++ b/docs/manuals/en/new_main_reference/source/autochangers.rst @@ -26,8 +26,8 @@ each of which is explained in more detail after this list: - That each Volume (tape) to be used must be defined in the Catalog and have a Slot number assigned to it so that Bareos knows where the Volume is in the autochanger. This is generally done with the - :strong:`label ` command, but can also done after the - tape is labeled using the :strong:`update slots` + :strong:`2label` command, but can also done after the + tape is labeled using the :strong:`3update slots` command. See below for more details. You must pre-label the tapes manually before using them. @@ -55,8 +55,8 @@ refer to the :ref:`Testing Autochanger ` chapter. Bareos also supports autochangers with barcode readers. This support -includes two Console commands: :strong:`label barcodes` -and :strong:`update slots`. For more details on these +includes two Console commands: :strong:`3label barcodes` +and :strong:`3update slots`. For more details on these commands, see the chapter about :ref:`Barcodes`. Current Bareos autochanger support does not include cleaning, stackers, @@ -238,11 +238,11 @@ will, using the Console program, assign a slot. This information is kept in Bareos’s catalog database along with the other data for the volume. If no slot is given, or the slot is set to zero, Bareos will not attempt to use the autochanger even if all the necessary configuration records -are present. When doing a :strong:`mount ` command on an +are present. When doing a :strong:`2mount` command on an autochanger, you must specify which slot you want mounted. If the drive is loaded with a tape from another slot, it will unload it and load the correct tape, but normally, no tape will be loaded because an -:strong:`unmount ` command causes Bareos to unload the +:strong:`2unmount` command causes Bareos to unload the tape in the drive. You can check if the Slot number and InChanger flag by: @@ -352,7 +352,7 @@ name). If your autochanger has barcode labels, you can label all the Volumes in your autochanger one after another by using the -:strong:`label barcodes` command. For each tape in the +:strong:`3label barcodes` command. For each tape in the changer containing a barcode, Bareos will mount the tape and then label it with the same name as the barcode. An appropriate Media record will also be created in the catalog. Any barcode that begins with the same diff --git a/docs/manuals/en/new_main_reference/source/bconsole.rst b/docs/manuals/en/new_main_reference/source/bconsole.rst index 3e4eaced284..64c34348f1a 100644 --- a/docs/manuals/en/new_main_reference/source/bconsole.rst +++ b/docs/manuals/en/new_main_reference/source/bconsole.rst @@ -317,11 +317,11 @@ current days Used to define the number of days the - :strong:`list nextvol` command should consider when + :strong:`3list nextvol` command should consider when looking for jobs to be run. The days keyword can also be used on the - :strong:`status dir` command so that it will display + :strong:`3status dir` command so that it will display jobs scheduled for the number of days you want. It can also be used - on the :strong:`rerun ` command, where it will + on the :strong:`2rerun` command, where it will automatically select all failed jobids in the last number of days for rerunning. @@ -338,8 +338,8 @@ directory enabled This keyword can appear on the - :strong:`update volume` as well as the - :strong:`update slots` commands, and can allows one + :strong:`3update volume` as well as the + :strong:`3update slots` commands, and can allows one of the following arguments: yes, true, no, false, archived, 0, 1, 2. Where 0 corresponds to no or false, 1 corresponds to yes or true, and 2 corresponds to archived. Archived volumes will not be used, @@ -363,7 +363,7 @@ help Used in the show command. Takes no arguments. hours - Used on the :strong:`rerun ` command to select all + Used on the :strong:`2rerun` command to select all failed jobids in the last number of hours for rerunning. jobs @@ -383,7 +383,7 @@ jobid the catalog. Probably you will refer specific Jobs that ran using their numeric JobId. - JobId can be used on the :strong:`rerun` command to + JobId can be used on the :raw-latex:`\bcommand{rerun}` command to select all jobs failed after and including the given jobid for rerunning. @@ -477,18 +477,18 @@ add add [pool=] [storage=] [jobid=] - Normally, the :strong:`label ` command is used rather - than this command because the :strong:`label ` + Normally, the :strong:`2label` command is used rather + than this command because the :strong:`2label` command labels the physical media (tape, disk,, ...) and does the - equivalent of the :strong:`add ` command. The - :strong:`add ` command affects only the Catalog and + equivalent of the :strong:`2add` command. The + :strong:`2add` command affects only the Catalog and not the physical media (data on Volumes). The physical media must exist and be labeled before use (usually with the - :strong:`label ` command). This command can, however, + :strong:`2label` command). This command can, however, be useful if you wish to add a number of Volumes to the Pool that will be physically labeled at a later time. It can also be useful if you are importing a tape from another site. Please see the - :strong:`label ` command for the list of legal + :strong:`2label` command for the list of legal characters in a Volume name. autodisplay @@ -573,7 +573,7 @@ cancel another job) - so you cannot cancel the job from within a console anymore. Therefore it is possible to cancel a job by JobId on the storage daemon. It might be helpful to execute a - :strong:`status storage ` on the Storage Daemon to + :strong:`2status storage` on the Storage Daemon to make sure what job you want to cancel. Usage: @@ -629,8 +629,8 @@ configure .. _`section-bcommandConfigure`: section-bcommandConfigure Configures director resources during runtime. The first configure - subcommands are :strong:`configure add` and - :strong:`configure export`. Other subcommands may + subcommands are :strong:`3configure add` and + :strong:`3configure export`. Other subcommands may follow in later releases. configure add @@ -1186,12 +1186,12 @@ label The preferable method to relabel a Volume is to first purge the volume, either automatically, or explicitly with the - :strong:`purge ` command, then use the - :strong:`relabel ` command described below. + :strong:`2purge` command, then use the + :strong:`2relabel` command described below. If your autochanger has barcode labels, you can label all the Volumes in your autochanger one after another by using the - :strong:`label barcodes` command. For each tape in + :strong:`3label barcodes` command. For each tape in the changer containing a barcode, Bareos will mount the tape and then label it with the same name as the barcode. An appropriate Media record will also be created in the catalog. Any barcode that @@ -1266,7 +1266,7 @@ list In general if you do not specify all the command line arguments, the command will prompt you for what is needed. - The :strong:`list nextvol` command will print the + The :strong:`3list nextvol` command will print the Volume name to be used by the specified job. You should be aware that exactly what Volume will be used depends on a lot of factors including the time and what a prior job will do. It may fill a tape @@ -1280,15 +1280,15 @@ list specification to specify up to 50 days. For example, if on Friday, you want to see what Volume will be needed on Monday, for job MyJob, you would use - :strong:`list nextvol job=MyJob days=3`. + :strong:`3list nextvol job=MyJob days=3`. If you wish to add specialized commands that list the contents of the catalog, you can do so by adding them to the :file:`query.sql` file. However, this takes some knowledge of programming SQL. Please see the - :strong:`query ` command below for additional + :strong:`2query` command below for additional information. See below for listing the full contents of a catalog - record with the :strong:`llist ` command. + record with the :strong:`2llist` command. As an example, the command **list pools** might produce the following output: @@ -1397,7 +1397,7 @@ mount Bareos should examine the tape. This command is normally used only after there was no Volume in a drive and Bareos requests you to mount a new Volume or when you have specifically unmounted a Volume - with the :strong:`unmount ` console command, which + with the :strong:`2unmount` console command, which causes Bareos to close the drive. If you have an autoloader, the mount command will not cause Bareos to operate the autoloader unless you specify a **slot** and possibly a **drive**. The various forms @@ -1416,7 +1416,7 @@ mount :raw-latex:`\linkResourceDirectiveValue{Sd}{Device}{Automatic Mount}{yes}`, under most circumstances, Bareos will automatically access the Volume unless you have explicitly - :strong:`unmount `ed it in the Console program. + :strong:`2unmount`ed it in the Console program. move .. index:: @@ -1486,7 +1486,7 @@ purge because you can delete catalog records associated with current backups of files, and we recommend that you do not use it unless you know what you are doing. The permitted forms of - :strong:`purge ` are: + :strong:`2purge` are: :: @@ -1499,7 +1499,7 @@ purge [volume [=] [storage=] [pool=] [devicetype=] [drive=] [action=]] | [quota [client=]] - For the :strong:`purge ` command to work on volume + For the :strong:`2purge` command to work on volume catalog database records the volume status must be :raw-latex:`\volumestatus{Append}`, :raw-latex:`\volumestatus{Full}`, :raw-latex:`\volumestatus{Used}` @@ -1521,9 +1521,9 @@ purge *purge volume action=truncate storage=File pool=Full - However, normally you should use the :strong:`purge ` + However, normally you should use the :strong:`2purge` command only to purge a volume from the catalog and use the - :strong:`truncate ` command to truncate the volume on + :strong:`2truncate` command to truncate the volume on the |bareosSd|. resolve @@ -1534,7 +1534,7 @@ resolve specified as DNS names. As the different components of Bareos will establish network connections to other Bareos components, it is important that DNS name resolution works on involved components and - delivers the same results. The :strong:`resolve ` + delivers the same results. The :strong:`2resolve` command can be used to test DNS resolution of a given hostname on director, storage daemon or client. @@ -1598,7 +1598,7 @@ relabel :raw-latex:`\volumestatus{Purged}` or :raw-latex:`\volumestatus{Recycle}`. This happens automatically as a result of applying retention periods or you may explicitly purge the - volume using the :strong:`purge ` command. + volume using the :strong:`2purge` command. Once the volume is physically relabeled, the old data previously written on the Volume is lost and cannot be recovered. @@ -1628,7 +1628,7 @@ release re-read the tape label to find out what tape is mounted. If you want to be able to use the drive with another program (e.g. :program:`mt`), you must use the - :strong:`unmount ` command to cause Bareos to + :strong:`2unmount` command to cause Bareos to completely release (close) the device. reload @@ -2054,13 +2054,13 @@ status started using the "File" device is that the device is blocked waiting for media – that is Bareos needs you to label a Volume. - The command :strong:`status scheduler ` + The command :strong:`2status scheduler` (12.4.4) can be used to check when a certain schedule will trigger. This gives - more information than :strong:`status director `. + more information than :strong:`2status director`. Called without parameters, - :strong:`status scheduler ` shows a preview for all + :strong:`2status scheduler` shows a preview for all schedules for the next 14 days. It first shows a list of the known schedules and the jobs that will be triggered by these jobs, and next, a table with date (including weekday), schedule name and @@ -2113,7 +2113,7 @@ status Mo 17-Jun-2013 21:10 WeeklyCycleAfterBackup Level=Full ==== - :strong:`status scheduler` accepts the following + :strong:`3status scheduler` accepts the following parameters: client=clientname @@ -2132,7 +2132,7 @@ status days= can be combined with the other selection criteria. In case you are running a maintained version of Bareos, the command - :strong:`status subscriptions` + :strong:`3status subscriptions` (12.4.4) can help you to keep the overview over the subscriptions that are used. @@ -2153,7 +2153,7 @@ status } Using the console command - :strong:`status subscriptions`, the status of the + :strong:`3status subscriptions`, the status of the subscriptions can be checked any time interactively: :: @@ -2238,14 +2238,14 @@ truncate When using a disk volume (and other volume types also) the volume file still resides on the |bareosSd|. If you want to reclaim disk space, you can use the - :strong:`truncate volstatus=Purged` command. When + :strong:`3truncate volstatus=Purged` command. When used on a volume, it rewrites the header and by this frees the rest of the disk space. If the volume you want to get rid of has not the :raw-latex:`\volumestatus{Purged}` status, you first have to use the - :strong:`prune volume` or even the - :strong:`purge volume` command to free the volume + :strong:`3prune volume` or even the + :strong:`3purge volume` command to free the volume from all remaining jobs. This command is available since Bareos @@ -2255,7 +2255,7 @@ umount .. index:: triple: Console; Command; umount; Alias for - :strong:`unmount `. + :strong:`2unmount`. unmount .. index:: @@ -2283,7 +2283,7 @@ unmount specified, it will assume drive 1. In most cases, it is preferable to use the - :strong:`release ` instead. + :strong:`2release` instead. update .. index:: @@ -2311,7 +2311,7 @@ update - stats In the case of updating a Volume - (:strong:`update volume`), you will be prompted for + (:strong:`3update volume`), you will be prompted for which value you wish to change. The following Volume parameters may be changed: @@ -2341,7 +2341,7 @@ update - For slots :strong:`update slots`, Bareos will obtain + For slots :strong:`3update slots`, Bareos will obtain a list of slots and their barcodes from the Storage daemon, and for each barcode found, it will automatically update the slot in the catalog Media record to correspond to the new value. This is very @@ -2354,11 +2354,11 @@ update in the autochanger. If you do not have barcodes, you can accomplish the same thing by - using the :strong:`update slots scan` command. The + using the :strong:`3update slots scan` command. The :option:`scan` keyword tells Bareos to physically mount each tape and to read its VolumeName. - For Pool :strong:`update pool`, Bareos will move the + For Pool :strong:`3update pool`, Bareos will move the Volume record from its existing pool to the pool specified. For **Volume from Pool**, **All Volumes from Pool** and **All @@ -2367,7 +2367,7 @@ update MaxVolJobs, MaxVolFiles, and MaxVolBytes. For updating the statistics, use - :strong:`updates stats`, see + :strong:`3updates stats`, see :ref:`section-JobStatistics`. The full form of the update command with all command line arguments @@ -2418,7 +2418,7 @@ var a string or quoted string and does variable expansion on it mostly the same way variable expansion is done on the **Label Format**:sup:`Dir`:sub:`Pool` string. - The difference between the :strong:`var ` command and + The difference between the :strong:`2var` command and the actual **Label Format**:sup:`Dir`:sub:`Pool` process is that during the var command, no job is running so dummy values diff --git a/docs/manuals/en/new_main_reference/source/bootstrap.rst b/docs/manuals/en/new_main_reference/source/bootstrap.rst index 0b570f1b43e..b88d98f2c10 100644 --- a/docs/manuals/en/new_main_reference/source/bootstrap.rst +++ b/docs/manuals/en/new_main_reference/source/bootstrap.rst @@ -18,7 +18,7 @@ The information in this chapter is provided so that you may either create your own bootstrap files, or so that you can edit a bootstrap file produced by Bareos. However, normally the bootstrap file will be automatically created for you during the -:strong:`restore ` in the Console program, or by using a +:strong:`2restore` in the Console program, or by using a **Write Bootstrap**:sup:`Dir`:sub:`Job` record in your Backup Jobs, and thus you will never need to know the details of this file. diff --git a/docs/manuals/en/new_main_reference/source/catmaintenance.rst b/docs/manuals/en/new_main_reference/source/catmaintenance.rst index c56e15ee470..b332ddc579f 100644 --- a/docs/manuals/en/new_main_reference/source/catmaintenance.rst +++ b/docs/manuals/en/new_main_reference/source/catmaintenance.rst @@ -997,7 +997,7 @@ However, these statistics are accurate only if your job retention is greater than your statistics period. Ie, if jobs are purged from the catalog, you won’t be able to use them. -Now, you can use the :strong:`update stats [days=num]` +Now, you can use the :strong:`3update stats [days=num]` console command to fill the JobHistory table with new Job records. If you want to be sure to take in account only good jobs, ie if one of your important job has failed but you have fixed the problem and restarted it @@ -1014,7 +1014,7 @@ The defines the length of time that Bareos will keep statistics job records in the Catalog database after the Job End time. This information is stored in the ``JobHistory`` table. When this time period expires, and -if user runs :strong:`prune stats` command, Bareos will +if user runs :strong:`3prune stats` command, Bareos will prune (remove) Job records that are older than the specified period. You can use the following Job resource in your nightly diff --git a/docs/manuals/en/new_main_reference/source/client-initiated-connection.rst b/docs/manuals/en/new_main_reference/source/client-initiated-connection.rst index 84665847a58..4869087dd9e 100644 --- a/docs/manuals/en/new_main_reference/source/client-initiated-connection.rst +++ b/docs/manuals/en/new_main_reference/source/client-initiated-connection.rst @@ -61,7 +61,7 @@ Initiated Connections the |bareosDir| only establishes a network connection when this is required. With Client Initiated Connections, the |bareosFd| connects to the |bareosDir| and the |bareosDir| keeps these -connections open. The command :strong:`status dir` will +connections open. The command :strong:`3status dir` will show all waiting connections: @@ -94,7 +94,7 @@ If none of this worked, the job fails. When a waiting connection is used for a job, the |bareosFd| will detect this and creates an additional connection. This is required, to keep the client responsive for -additional commands, like :strong:`cancel `. +additional commands, like :strong:`2cancel`. To get feedback in case the |bareosFd| fails to connect to the |bareosDir|, consider configuring diff --git a/docs/manuals/en/new_main_reference/source/consoleconf.rst b/docs/manuals/en/new_main_reference/source/consoleconf.rst index d0bed1a6b68..c0baaf43279 100644 --- a/docs/manuals/en/new_main_reference/source/consoleconf.rst +++ b/docs/manuals/en/new_main_reference/source/consoleconf.rst @@ -264,7 +264,7 @@ Schedule or Pool, a FileSet named :raw-latex:`\resourcename*{Dir}{FileSet}{Restricted Client's FileSet}`, a Catalog named :raw-latex:`\resourcename*{Dir}{Catalog}{MyCatalog}` and the only command he can use in the Console is the -:strong:`run ` command. In other words, this user is +:strong:`2run` command. In other words, this user is rather limited in what he can see and do with Bareos. For details how to configure ACLs, see the :strong:`Acl` data type description. diff --git a/docs/manuals/en/new_main_reference/source/dirdconf.rst b/docs/manuals/en/new_main_reference/source/dirdconf.rst index a33c95a95be..0466d116d2a 100644 --- a/docs/manuals/en/new_main_reference/source/dirdconf.rst +++ b/docs/manuals/en/new_main_reference/source/dirdconf.rst @@ -512,7 +512,7 @@ attributes (Maximum Jobs, Retention Period, Recycle flag, ...) that will be given to a Volume when it is created. This avoids the need for you to answer a large number of questions when labeling a new Volume. Each of these attributes can later be changed on a Volume by Volume basis using -the :strong:`update ` command in the console program. +the :strong:`2update` command in the console program. Note that you must explicitly specify which Pool Bareos is to use with each Job. Bareos will not automatically search for the correct Pool. @@ -522,7 +522,7 @@ to the Catalog database. This is done automatically by the Director each time that it starts. Finally, if you change the Pool definition in the Director’s configuration file and restart Bareos, the pool will be updated alternatively you can use the -:strong:`update pool` console command to refresh the +:strong:`3update pool` console command to refresh the database image. It is this database image rather than the Director’s resource image that is used for the default Volume attributes. Note, for the pool to be automatically created or updated, it must be explicitly @@ -531,9 +531,9 @@ referenced by a Job resource. If automatic labeling is not enabled (see :ref:`AutomaticLabeling`) the physical media must be manually labeled. The labeling can either be done with the -:strong:`label ` command in the console program or using +:strong:`2label` command in the console program or using the :program:`btape` program. The preferred method is to use -the :strong:`label ` command in the console program. +the :strong:`2label` command in the console program. Generally, automatic labeling is enabled for :raw-latex:`\linkResourceDirectiveValue{Sd}{Device}{Device Type}{File}` and disabled for @@ -554,19 +554,19 @@ ensure that the Volume selected from the Pool is identical to that required by the Storage resource you have specified for the Job. -If you use the :strong:`label ` command in the console +If you use the :strong:`2label` command in the console program to label the Volumes, they will automatically be added to the Pool, so this last step is not normally required. It is also possible to add Volumes to the database without explicitly labeling the physical volume. This is done with the -:strong:`add ` console command. +:strong:`2add` console command. As previously mentioned, each time Bareos starts, it scans all the Pools associated with each Catalog, and if the database record does not already exist, it will be created from the Pool Resource definition. If you change the Pool definition, you manually have to call -:strong:`update pool` command in the console program to +:strong:`3update pool` command in the console program to propagate the changes to existing volumes. The Pool Resource defined in the Director’s configuration may contain @@ -743,7 +743,7 @@ Named Console provided on the **Name**:sup:`Dir`:sub:`Console` directive, is the same as a Client name, that console is - permitted to use the :strong:`SetIP ` command to + permitted to use the :strong:`2SetIP` command to change the Address directive in the Director’s client resource to the IP address of the Console. This permits portables or other machines using DHCP (non-fixed IP addresses) to "notify" the diff --git a/docs/manuals/en/new_main_reference/source/disk.rst b/docs/manuals/en/new_main_reference/source/disk.rst index 90400ff9526..cf8c5bb685e 100644 --- a/docs/manuals/en/new_main_reference/source/disk.rst +++ b/docs/manuals/en/new_main_reference/source/disk.rst @@ -138,7 +138,7 @@ Volumes. Once a Volume has been created, it gets its own copy of the Pool defaults, and subsequently changing the Pool will have no effect on existing Volumes. You can either manually change the Volume values, or refresh them from the Pool defaults using the -:strong:`update volume` command in the Console. As an +:strong:`3update volume` command in the Console. As an example of the use of one of the above, suppose your Pool resource contains: diff --git a/docs/manuals/en/new_main_reference/source/ndmp.rst b/docs/manuals/en/new_main_reference/source/ndmp.rst index 7b39629067c..b7293623b23 100644 --- a/docs/manuals/en/new_main_reference/source/ndmp.rst +++ b/docs/manuals/en/new_main_reference/source/ndmp.rst @@ -583,7 +583,7 @@ Verify that the configuration is correct: * The output looks the same, as if a -:strong:`status storage=File` would have been called. +:raw-latex:`\bcommand{status storage=File}` would have been called. .. _section-NdmpFileset: @@ -596,7 +596,7 @@ decided to backup :file:`/ifs/home` directory. The specified directory needs to be a filesystem or a subdirectory of a filesystem which can be accessed by NDMP. Which filesystems are -available is showed in the :strong:`status client` output +available is showed in the :strong:`3status client` output of the NDMP client. .. index:: @@ -1578,7 +1578,7 @@ in **Device**:sup:`Dir`:sub:`Storage` and } Verify that the connection to the NDMP Tape Agent and Robot Agent work, -by running the :strong:`status storage` command. +by running the :strong:`3status storage` command. The :raw-latex:`\TapeAgent `will return information about the available tape drives. The :raw-latex:`\RobotAgent `will return information about diff --git a/docs/manuals/en/new_main_reference/source/programs.rst b/docs/manuals/en/new_main_reference/source/programs.rst index 9faf36a952a..e014bb10efe 100644 --- a/docs/manuals/en/new_main_reference/source/programs.rst +++ b/docs/manuals/en/new_main_reference/source/programs.rst @@ -189,7 +189,7 @@ In the case of a tape, this is the physical device name such as \warning{If you have Bareos running and you want to use one of these programs, you will either need to stop the \bareosSd - or \bcommand{unmount}{} any tape drive you want to use, + or :strong:`unmount` any tape drive you want to use, otherwise the drive may get busy because Bareos is using it. After this, you can use the command \command{mtx} or \ilink{mtx-changer script}{section-MtxChangerManualUsage} to load the required volume into the tape drive. @@ -1073,7 +1073,7 @@ the Director starts, it will recreate any missing Client records in the catalog. Another problem you will have is that even if the Volumes (Media records) are recreated in the database, they will not have their autochanger status and slots properly set. As a result, you will need to -repair that by using the :strong:`update slots` command. +repair that by using the :strong:`3update slots` command. There may be other considerations as well. Rather than bscanning, you should always attempt to recover you previous catalog backup. @@ -1196,7 +1196,7 @@ If you had added a second **-v** option to the command line, Bareos would have been even more verbose, dumping virtually all the details of each Job record it encountered. -Now if you start Bareos and enter a :strong:`list jobs` +Now if you start Bareos and enter a :strong:`3list jobs` command to the console program, you will get: @@ -1241,7 +1241,7 @@ There are two solutions to this problem. The first is possibly the simplest and is to mark the volume as Used before doing any backups. The second is to manually correct the number of files listed in the Media record of the catalog. This procedure is documented elsewhere in the -manual and involves using the :strong:`update volume` +manual and involves using the :strong:`3update volume` command in :program:`bconsole`. Using bscan to Correct the Volume File Count diff --git a/docs/manuals/en/new_main_reference/source/quickstart.rst b/docs/manuals/en/new_main_reference/source/quickstart.rst index 0b66018ab6c..ff896eed4b6 100644 --- a/docs/manuals/en/new_main_reference/source/quickstart.rst +++ b/docs/manuals/en/new_main_reference/source/quickstart.rst @@ -75,7 +75,7 @@ Before Bareos will read or write a Volume, the physical Volume must have a Bareos software label so that Bareos can be sure the correct Volume is mounted. Depending on your configuration, this is either done automatically by Bareos or manually using the -:strong:`label ` command in the Console program. +:strong:`2label` command in the Console program. The steps for creating a Pool, adding Volumes to it, and writing software labels to the Volumes, may seem tedious at first, but in fact, diff --git a/docs/manuals/en/new_main_reference/source/recycling.rst b/docs/manuals/en/new_main_reference/source/recycling.rst index 0ff0ca3ca46..c7c2af4928a 100644 --- a/docs/manuals/en/new_main_reference/source/recycling.rst +++ b/docs/manuals/en/new_main_reference/source/recycling.rst @@ -186,7 +186,7 @@ the files. When a Job record is pruned, the Volume (Media record) for that Job can still remain in the database, and if you do a -:strong:`list volumes`, you will see the volume +:strong:`3list volumes`, you will see the volume information, but the Job records (and its File records) will no longer be available. @@ -344,7 +344,7 @@ used the defaults for all these items. Volume and if found move it to the current Pool for the Job and use it. Note, when the Scratch Volume is moved into the current Pool, the basic Pool defaults are applied as if it is a newly labeled Volume - (equivalent to an :strong:`update volume from pool` + (equivalent to an :strong:`3update volume from pool` command). #. If we were looking for Volumes in the Autochanger, go back to step 2 @@ -785,25 +785,23 @@ want to manually force reuse (recycling) of a Volume. Assuming that you want to keep the Volume name, but you simply want to write new data on the tape, the steps to take are: -- Use the :strong:`update volume` command in the Console +- Use the :strong:`3update volume` command in the Console to ensure that :raw-latex:`\volumeparameter{Recycle}{yes}`. -- Use the :strong:`purge jobs volume` command in the +- Use the :strong:`3purge jobs volume` command in the Console to mark the Volume as :raw-latex:`\volumestatus{Purged}`. - Check by using :strong:`list volumes`. + Check by using :strong:`3list volumes`. Once the Volume is marked Purged, it will be recycled the next time a Volume is needed. If you wish to reuse the tape by giving it a new name, use the -:strong:`relabel ` instead of the -:strong:`purge ` command. +:strong:`2relabel` instead of the +:strong:`2purge` command. - -.. warning:: - The \bcommand{delete}{ command can be dangerous. Once it is + \warning{The :strong:`delete` command can be dangerous. Once it is done, to recover the File records, you must either restore your database as it - was before the \bcommand{delete}{} command or use the :ref:`bscan` utility program to + was before the :strong:`delete` command or use the :ref:`bscan` utility program to scan the tape and recreate the database entries.} diff --git a/docs/manuals/en/new_main_reference/source/releasenotes.rst b/docs/manuals/en/new_main_reference/source/releasenotes.rst index f0cc7f137d9..cd819a6c3ec 100644 --- a/docs/manuals/en/new_main_reference/source/releasenotes.rst +++ b/docs/manuals/en/new_main_reference/source/releasenotes.rst @@ -96,11 +96,11 @@ releases are only published on https://download.bareos.com.\| \item NDMP fixes \item Virtual Backup fixes \item \package{bareos-storage-droplet}: improvements - \item \command{bareos-dbcheck} improvements and fixes: with older versions it could happen, that it destroys structures required by \bcommand{.bvfs_*}{}. + \item \command{bareos-dbcheck} improvements and fixes: with older versions it could happen, that it destroys structures required by :strong:`.bvfs_*`. \item \ticket{850} fixes a bug on :strong:`Univention`: fixes a problem of regenerating passwords when resyncing settings. - \item \ticket{890} \bcommand{.bvfs_update}{} fix. Before there have been cases where it did not update the cache. - \item \bcommand{.bvfs_lsdirs}{} make limit- and offset-option work correctly. - \item \bcommand{.bvfs_lsdirs}{} show special directory (like \verb|path:@bpipe@/|) on the same level as \verb|path:/|. + \item \ticket{890} :strong:`.bvfs_update` fix. Before there have been cases where it did not update the cache. + \item :strong:`.bvfs_lsdirs` make limit- and offset-option work correctly. + \item :strong:`.bvfs_lsdirs` show special directory (like \verb|path:@bpipe@/|) on the same level as \verb|path:/|. \item \ticket{895} added description to the output of \bcommand{show}{filesets}. \item \bareosWebui: Restore Browser fixes \begin{itemize} @@ -150,7 +150,7 @@ releases are only published on https://download.bareos.com.\| \item For the denormalization the database schema must be modified. \warning{Updating the database to schema version ≥ 2170 will increase the required disk space. Especially it will require around twice the amount of the current database disk space during the migration.} - \item The **Filename} database table does no longer exists. Therefore the \bcommand{.bvfs_*}{} commands do no longer output the \dbcolumn{FilenameId** column. + \item The **Filename} database table does no longer exists. Therefore the :strong:`.bvfs_*` commands do no longer output the \dbcolumn{FilenameId** column. \end{itemize} \item NDMP\_NATIVE support has been added. This include the NDMP features DAR and DDAR. For details see :ref:`section-NdmpNative`. @@ -159,7 +159,7 @@ releases are only published on https://download.bareos.com.\| \item \command{bareos-dbcheck}: disable all interactive questions in batch mode. \item \bcommand{list}{files}: also show deleted files (accurate mode). \item \bcommand{list}{jobstatastics}: added. - \item \bcommand{purge}{}: added confirmation. + \item :strong:`purge`: added confirmation. \item \bcommand{list}{volumes}: fix limit and offset handling. \item \ticket{629} Windows: restore directory attributes. \item \ticket{639} tape: fix block size handling, AWS VTL iSCSI devices @@ -216,9 +216,9 @@ releases are only published on https://download.bareos.com.\| This release contains several bugfixes and enhancements. Excerpt: \begin{itemize} \item Fixes a Director crash, when enabling debugging output - \item \bcommand{.bvfs_lsdirs}{}: improve performance, especially when having a large number of directories + \item :strong:`.bvfs_lsdirs`: improve performance, especially when having a large number of directories \begin{itemize} - \item To optimize the performance of the SQL query used by \bcommand{.bvfs_lsdirs}{}, it is important to + \item To optimize the performance of the SQL query used by :strong:`.bvfs_lsdirs`, it is important to have the following indexes: \item PostgreSQL \begin{itemize} @@ -256,18 +256,18 @@ releases are only published on https://download.bareos.com.\| This release contains several bugfixes and enhancements. Excerpt: \begin{itemize} - \item Prevent from director crash when using incorrect paramaters of \bcommand{.bvfs_*}{} commands. + \item Prevent from director crash when using incorrect paramaters of :strong:`.bvfs_*` commands. \item Director now closes all configuration files when reloading failed. \item Storage daemon now closes the network connection when MaximumConcurrentJobs reached. \item New directive \configdirective{LanAddress} was added to the Client and Storage Resources of the director to facilitate a network topology where client and storage are situated inside of a LAN, but the Director is outside of that LAN. See :ref:`LanAddress` for details. \item A Problem in the storage abstraction layer was fixed where the director picked the wrong storage daemon when multiple storages/storage daemons were used. \item The device spool size calculation when using secure erase was fixed. - \item \bcommand{.bvfs_lsdirs}{} no longer shows empty directories from accurate jobs. + \item :strong:`.bvfs_lsdirs` no longer shows empty directories from accurate jobs. \begin{itemize} \item .. warning:: This decreases performance if your environment has a large numbers of directories. Creating an index improves the performance. - %In Bareos 16.2.6 the SQL Query used by \bcommand{.bvfs_lsdirs}{} was changed to not show + %In Bareos 16.2.6 the SQL Query used by :strong:`.bvfs_lsdirs` was changed to not show %empty directories from accurate jobs. It turned out that that the changed %query causes performance issues when larger amounts of directories were backed up.\\ \item \postgresql @@ -288,7 +288,7 @@ releases are only published on https://download.bareos.com.\| \path!echo "CREATE INDEX PathId_JobId_FileIndex_FileNameId ON File(PathId,JobId,FileIndex,FilenameId);" | mysql -u root bareos! \item However, with larger amounts of directories and/or involved jobs, even with this index - the performance of \bcommand{.bvfs_lsdirs}{} may still be insufficient. We are working on optimizing + the performance of :strong:`.bvfs_lsdirs` may still be insufficient. We are working on optimizing the SQL query for MySQL/MariaDB to solve this problem. \end{itemize} \end{itemize} diff --git a/docs/manuals/en/new_main_reference/source/spooling.rst b/docs/manuals/en/new_main_reference/source/spooling.rst index c5b850367b6..d8ed324cbb1 100644 --- a/docs/manuals/en/new_main_reference/source/spooling.rst +++ b/docs/manuals/en/new_main_reference/source/spooling.rst @@ -70,7 +70,7 @@ The following directives can be used to control data spooling. :option:`SpoolData=`:raw-latex:`\dtYesNo` - To override the Job specification in a bconsole session using the - :strong:`run` command: + :raw-latex:`\bcommand{run}` command: :option:`SpoolData=`:raw-latex:`\dtYesNo` Please note that this does not refer to a configuration statement, diff --git a/docs/manuals/en/new_main_reference/source/tables.rst b/docs/manuals/en/new_main_reference/source/tables.rst index d34a0883433..b7a12131131 100644 --- a/docs/manuals/en/new_main_reference/source/tables.rst +++ b/docs/manuals/en/new_main_reference/source/tables.rst @@ -30,7 +30,7 @@ JobStatus The status of a Bareos job is stored as abbreviation in the Catalog database table Job. It is also displayed by some bconsole commands, eg. -:strong:`list jobs`. +:strong:`3list jobs`. This table lists the abbreviations together with its description and weight. The weight is used, when multiple states are applicable for a diff --git a/docs/manuals/en/new_main_reference/source/tutorial.rst b/docs/manuals/en/new_main_reference/source/tutorial.rst index c42574e4457..aa6d9ef8dd9 100644 --- a/docs/manuals/en/new_main_reference/source/tutorial.rst +++ b/docs/manuals/en/new_main_reference/source/tutorial.rst @@ -111,7 +111,7 @@ something similar to the following: The asterisk is the console command prompt. -Type :strong:`help ` to see a list of available commands: +Type :strong:`2help` to see a list of available commands: @@ -199,7 +199,7 @@ At this point, we assume you have done the following: Furthermore, we assume for the moment you are using the default configuration files. -At this point, enter the :strong:`show filesets` and you +At this point, enter the :strong:`3show filesets` and you should get something similar this: @@ -428,7 +428,7 @@ above parameters (**mod**), or to not run the job (**no**). Please enter (an asterisk). If you wait a few seconds, then enter the command -:strong:`messages ` you will get back something like: +:strong:`2messages` you will get back something like: @@ -469,9 +469,9 @@ If you wait a few seconds, then enter the command 28-Apr-2003 14:30 rufus-dir: End auto prune. If you don’t see the output immediately, you can keep entering -:strong:`messages ` until the job terminates. +:strong:`2messages` until the job terminates. -Instead of typing :strong:`messages ` multiple times, you +Instead of typing :strong:`2messages` multiple times, you can also ask bconsole to wait, until a specific job is finished: @@ -482,10 +482,10 @@ can also ask bconsole to wait, until a specific job is finished: *wait jobid=1 -or just :strong:`wait `, which waits for all running jobs +or just :strong:`2wait`, which waits for all running jobs to finish. -Another useful command is :strong:`autodisplay on`. With +Another useful command is :strong:`3autodisplay on`. With autodisplay activated, messages will automatically be displayed as soon as they are ready. @@ -514,7 +514,7 @@ of the job just run. If you run additional jobs, they will be appended to this Volume unless you specify otherwise. If you would like to stop here, you can simply enter -:strong:`quit ` in the Console program. +:strong:`2quit` in the Console program. If you would like to try restoring the files that you just backed up, read the following section. @@ -631,11 +631,11 @@ current backup, in this case, there is only one, and the Storage daemon was also automatically chosen. Bareos then took all the files that were in Job number 1 and entered them into a **directory tree** (a sort of in memory representation of your filesystem). At this point, you can use -the :strong:`cd ` and :strong:`ls ` or -:strong:`dir ` commands to walk up and down the directory +the :strong:`2cd` and :strong:`2ls` or +:strong:`2dir` commands to walk up and down the directory tree and view what files will be restored. For example, if you enter -:strong:`cd /usr/sbin` and then enter -:strong:`dir ` you will get a listing of all the files in +:strong:`3cd /usr/sbin` and then enter +:strong:`2dir` you will get a listing of all the files in the :file:`/usr/sbin/` directory. On your system, the path might be somewhat different. For more information on this, please refer to the @@ -728,7 +728,7 @@ If you answer **yes** your files will be restored to the files to their original locations, you must use the **mod** option and explicitly set **Where:** to nothing (or to /). We recommend you go ahead and answer **yes** and after a brief moment, enter -:strong:`messages `, at which point you should get a +:strong:`2messages`, at which point you should get a listing of all the files that were restored as well as a summary of the job that looks similar to this: @@ -789,7 +789,7 @@ Quitting the Console Program single: Quitting the Console Program -Simply enter the command :strong:`quit `. +Simply enter the command :strong:`2quit`. .. _SecondClient: @@ -841,7 +841,7 @@ Bareos 16.2.4 offers the add resources to the |bareosDir|. Start the :program:`bconsole` and use the -:strong:`configure add client` command. Address must be a +:strong:`3configure add client` command. Address must be a DNS resolvable name or an IP address. @@ -1020,7 +1020,7 @@ Manual configuration ^^^^^^^^^^^^^^^^^^^^ If you have not created the :sup:`Fd` :strong:`Director` by -:strong:`configure `, you can create it also manually. If +:strong:`2configure`, you can create it also manually. If your |bareosDir| is also named **bareos-dir**, modify or create the file :file:`/etc/bareos/bareos-fd.d/director/bareos-dir.conf`: @@ -1075,7 +1075,7 @@ The following example show how to - Add a job resource. -- Dry-run the job (:strong:`estimate listing`). +- Dry-run the job (:strong:`3estimate listing`). - Run the job. @@ -1127,7 +1127,7 @@ the drive will be ready to be used. The same considerations apply if you have just mounted a blank tape in a drive. It can take a minute or two before the drive properly recognizes that the tape is blank. If you attempt to -:strong:`mount ` the tape with the Console program during +:strong:`2mount` the tape with the Console program during this recognition period, it is quite possible that you will hang your SCSI driver. As a consequence, you are again urged to have patience when inserting blank tapes. Let the device settle down before attempting to @@ -1197,7 +1197,7 @@ help help list Show detail information about a specific command, in this case the - command :strong:`list `. + command :strong:`2list`. status dir .. index:: diff --git a/docs/manuals/en/new_main_reference/source/webui.rst b/docs/manuals/en/new_main_reference/source/webui.rst index 5d20e0b7cc9..787f1fab761 100644 --- a/docs/manuals/en/new_main_reference/source/webui.rst +++ b/docs/manuals/en/new_main_reference/source/webui.rst @@ -520,8 +520,8 @@ reasons: #. The handling of :strong:`Acl` s is more strict in Bareos 16.2 than it has been in Bareos 15.2. Substring matching is no longer - enabled, therefore you need to change :strong:`.bvfs_*` - to :strong:`.bvfs_.*` in your + enabled, therefore you need to change :raw-latex:`\bcommand{.bvfs_*}` + to :raw-latex:`\bcommand{.bvfs_.*}` in your **Command ACL**:sup:`Dir`:sub:`Profile` to have a proper regular expression. Otherwise the restore module won’t work any longer, especially the file browser.