diff options
| author | Bruno Friedmann <bruno.friedmann@bareos.com> | 2022-09-06 18:19:04 +0300 |
|---|---|---|
| committer | Bruno Friedmann <bruno.friedmann@bareos.com> | 2022-09-28 10:26:34 +0300 |
| commit | 2fa9b07c58e267ce50f735ab233a45d2ddc03243 (patch) | |
| tree | 7120e232effc42064b8ebb977d4a1be14df6158a /docs | |
| parent | f635940a4ae58c477b1be167bb73226434cfa662 (diff) | |
docs: Improving bareos tools section
- update sphinx indexes syntax
- unify usage to include tools .txt --help output
- add bsmtp to CMakelist for autogenerated usage
- bareos-dbcopy section Adjust section title level so bareos-dbcopy
section goes into bareos-tools chapter
- bls renew example with actual data and signatures
+ add ref section for storage-media-output-format
- btape speed section refresh
+ Specify flags name in the example.
+ Add btape program call. [OP #4989]
Co-authored-by: Jörg Steffens <joergsteffens@users.noreply.github.com>
Signed-off-by: Bruno Friedmann <bruno.friedmann@bareos.com>
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/manuals/CMakeLists.txt | 9 | ||||
| -rw-r--r-- | docs/manuals/source/Appendix/BareosPrograms.rst | 445 | ||||
| -rw-r--r-- | docs/manuals/source/DeveloperGuide/mediaformat.rst | 2 | ||||
| -rw-r--r-- | docs/manuals/source/include/autogenerated/usage/bsmtp.txt | 15 | ||||
| -rw-r--r-- | docs/manuals/source/man/bareos-dbcopy.rst | 10 |
5 files changed, 265 insertions, 216 deletions
diff --git a/docs/manuals/CMakeLists.txt b/docs/manuals/CMakeLists.txt index 69ed52a4f..be414af4b 100644 --- a/docs/manuals/CMakeLists.txt +++ b/docs/manuals/CMakeLists.txt @@ -201,6 +201,14 @@ if(${docs-build-json}) ) add_custom_command( + OUTPUT ${USAGE_DIR}/bsmtp.txt + COMMAND bsmtp --help >/dev/null + COMMAND ${PROJECT_SOURCE_DIR}/scripts/get-usage.sh $<TARGET_FILE:bsmtp> + ${USAGE_DIR} + DEPENDS bsmtp + ) + + add_custom_command( OUTPUT ${USAGE_DIR}/btape.txt COMMAND btape --help >/dev/null COMMAND ${PROJECT_SOURCE_DIR}/scripts/get-usage.sh $<TARGET_FILE:btape> @@ -228,6 +236,7 @@ if(${docs-build-json}) ${USAGE_DIR}/bpluginfo.txt ${USAGE_DIR}/bregex.txt ${USAGE_DIR}/bscan.txt + ${USAGE_DIR}/bsmtp.txt ${USAGE_DIR}/btape.txt ${USAGE_DIR}/bwild.txt ) diff --git a/docs/manuals/source/Appendix/BareosPrograms.rst b/docs/manuals/source/Appendix/BareosPrograms.rst index 771d15871..738b6f4e7 100644 --- a/docs/manuals/source/Appendix/BareosPrograms.rst +++ b/docs/manuals/source/Appendix/BareosPrograms.rst @@ -57,7 +57,9 @@ Each of the three daemons (Director, File, Storage) accepts a small set of optio bareos-dir ~~~~~~~~~~ -:index:`\ <single: Command; bareos-dir>`\ :index:`\ <single: Command Line Options>`\ +.. index:: + single: Command; bareos-dir + single: Command Line Options |dir|. @@ -66,7 +68,9 @@ bareos-dir bareos-sd ~~~~~~~~~ -:index:`\ <single: Command; bareos-sd>`\ :index:`\ <single: Command Line Options>`\ +.. index:: + single: Command; bareos-sd + single: Command Line Options |sd|. @@ -75,7 +79,9 @@ bareos-sd bareos-fd ~~~~~~~~~ -:index:`\ <single: Command; bareos-fd>`\ :index:`\ <single: Command Line Options>`\ +.. index:: + single: Command; bareos-fd + single: Command Line Options |fd|. @@ -92,16 +98,6 @@ bareos-webui For further information regarding the Bareos Webui, please refer to :ref:`section-webui`. -bat -~~~ - -:index:`\ <single: Command; bat>`\ - -.. _bat: - - - -The Bacula/Bareos Administration Tool (:command:`bat`) has been a native GUI for Bareos. It has been marked deprecated since :sinceVersion:`15.2.0: bat vs. bareos-webui`. Since Bareos :sinceVersion:`17.2.0: bat: removed from core distribution` it is no longer part of Bareos. We encourage the use of |webui| instead. .. _section-VolumeUtilityCommands: @@ -120,8 +116,8 @@ Parameter Specifying the Configuration ^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -Each of the utilities that deal with Volumes require a valid |sd| configuration (actually, the only part of the configuration file that these programs need is the :config:option:`Sd/Device`\ resource definitions). This permits the programs to find the configuration parameters for your :config:option:`sd/device/ArchiveDevice`\ . Using the :strong:`-c` option a custom |sd| configuration file or directory can be -selected. +Each of the utilities that deal with Volumes require a valid |sd| configuration (actually, the only part of the configuration file that these programs need is the :config:option:`Sd/Device`\ resource definitions). This permits the programs to find the configuration parameters for your :config:option:`sd/device/ArchiveDevice`\ . +Using the :strong:`-c` option a custom |sd| configuration file or directory can be selected. Specifying a Device ^^^^^^^^^^^^^^^^^^^ @@ -181,9 +177,9 @@ In the case of Bareos Volumes that are on files, you may simply append volumes a bls /var/lib/bareos/storage/volume1\|volume2 -where the backslash (\) was necessary as a shell escape to permit entering the vertical bar (|). +where the backslash (`\\`) was necessary as a shell escape to permit entering the vertical bar (`\|`). -And finally, if you feel that specifying a Volume name is a bit complicated with a bootstrap file, you can use the :strong:`-V` option (on all programs except :command:`bcopy`) to specify one or more Volume names separated by the vertical bar (|). For example: +And finally, if you feel that specifying a Volume name is a bit complicated with a bootstrap file, you can use the :strong:`-V` option (on all programs except :command:`bcopy`) to specify one or more Volume names separated by the vertical bar (`\|`). For example: .. code-block:: shell-session @@ -245,7 +241,7 @@ bls .. literalinclude:: /include/autogenerated/usage/bls.txt - + Normally if no options are specified, :command:`bls` will produce the equivalent output to the :command:`ls -l` command for each volume. For example, to list the contents of a tape: @@ -258,39 +254,52 @@ Or to list the contents of a volume file: .. code-block:: shell-session - bls FileStorage -V Full1 + bls FileStorage -V Full-0001 or .. code-block:: shell-session - bls /var/lib/bareos/storage -V Full1 + bls /var/lib/bareos/storage -V Full-0001 or .. code-block:: shell-session - bls /var/lib/bareos/storage/Full1 + bls /var/lib/bareos/storage/Full-0001 For example: .. code-block:: shell-session - root@host:~# bls FileStorage -V Full1 - bls: butil.c:282-0 Using device: "/var/lib/bareos/storage" for reading. - 12-Sep 18:30 bls JobId 0: Ready to read from volume "Full1" on device "FileStorage" (/var/lib/bareos/storage). - bls JobId 1: -rwxr-xr-x 1 root root 4614 2013-01-22 22:24:11 /usr/sbin/service - bls JobId 1: -rwxr-xr-x 1 root root 13992 2013-01-22 22:24:12 /usr/sbin/rtcwake - bls JobId 1: -rwxr-xr-x 1 root root 6243 2013-02-06 11:01:29 /usr/sbin/update-fonts-scale - bls JobId 1: -rwxr-xr-x 1 root root 43240 2013-01-22 22:24:10 /usr/sbin/grpck - bls JobId 1: -rwxr-xr-x 1 root root 16894 2013-01-22 22:24:11 /usr/sbin/update-rc.d - bls JobId 1: -rwxr-xr-x 1 root root 9480 2013-01-22 22:47:43 /usr/sbin/gss_clnt_send_err - ... - bls JobId 456: -rw-r----- 1 root bareos 1008 2013-05-23 13:17:45 /etc/bareos/bareos-fd.conf - bls JobId 456: drwxr-xr-x 2 root root 4096 2013-07-04 17:40:21 /etc/bareos/ - 12-Sep 18:30 bls JobId 0: End of Volume at file 0 on device "FileStorage" (/var/lib/bareos/storage), Volume "Full1" - 12-Sep 18:30 bls JobId 0: End of all volumes. - 2972 files found. + root@host:~# bls FileStorage -V Full-0001 -v + stored/butil.cc:304-0 Using device: "FileStorage" for reading. + 13-Sep 14:47 bls JobId 0: Ready to read from volume "Full-0001" on device "FileStorage" (/var/lib/bareos/storage). + bls JobId 1: -rwxr-xr-x 1 root root 1797 2022-09-13 14:36:48 /usr/sbin/bareos + bls JobId 1: -rwxr-xr-x 1 root root 3430 2022-09-13 14:36:48 /usr/sbin/btraceback + bls JobId 1: -rwxr-xr-x 1 root root 1668872 2022-09-13 14:36:48 /usr/sbin/bareos-fd + bls JobId 1: -rwxr-xr-x 1 root root 26576 2022-09-13 14:36:48 /usr/sbin/bscrypto + bls JobId 1: -rwxr-xr-x 1 root root 1189448 2022-09-13 14:36:48 /usr/sbin/bwild + bls JobId 1: -rwxr-xr-x 1 root root 1188048 2022-09-13 14:36:48 /usr/sbin/bregex + bls JobId 1: -rwxr-xr-x 1 root root 1210744 2022-09-13 14:36:48 /usr/sbin/bpluginfo + bls JobId 1: -rwxr-xr-x 1 root root 22568 2022-09-13 14:36:48 /usr/sbin/btestls + bls JobId 1: -rwxr-xr-x 1 root root 27464 2022-09-13 14:36:48 /usr/sbin/bsmtp + bls JobId 1: -rwxr-xr-x 1 root root 1516440 2022-09-13 14:36:48 /usr/sbin/bareos-sd + bls JobId 1: -rwxr-xr-x 1 root root 1249256 2022-09-13 14:36:48 /usr/sbin/bls + bls JobId 1: -rwxr-xr-x 1 root root 1228344 2022-09-13 14:36:48 /usr/sbin/bextract + bls JobId 1: -rwxr-xr-x 1 root root 1273720 2022-09-13 14:36:48 /usr/sbin/bscan + bls JobId 1: -rwxr-xr-x 1 root root 1316656 2022-09-13 14:36:48 /usr/sbin/btape + bls JobId 1: -rwxr-xr-x 1 root root 1206640 2022-09-13 14:36:48 /usr/sbin/bcopy + bls JobId 1: -rwxr-xr-x 1 root root 3165200 2022-09-13 14:36:48 /usr/sbin/bareos-dir + bls JobId 1: -rwxr-xr-x 1 root root 1730080 2022-09-13 14:36:48 /usr/sbin/bareos-dbcheck + bls JobId 1: -rwxr-xr-x 1 root root 2142248 2022-09-13 14:36:48 /usr/sbin/testfind + bls JobId 1: -rwxr-xr-x 1 root root 1344768 2022-09-13 14:36:48 /usr/sbin/bconsole + bls JobId 1: drwxr-xr-x 1 root root 348 2022-09-13 14:36:48 /usr/sbin/ + 13-Sep 14:47 bls JobId 0: End of Volume at file 0 on device "FileStorage" (/var/lib/bareos/storage), Volume "Full-0001" + 13-Sep 14:47 bls JobId 0: End of all volumes. + 23 files and directories found. + 13-Sep 14:47 bls JobId 0: Releasing device "FileStorage" (/var/lib/bareos/storage). + Show Detailed File Information ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ @@ -299,26 +308,28 @@ To retrieve information, about how a file is stored on the volume, you can use : .. code-block:: shell-session - root@host:~# bls FileStorage -V TestVolume001 -v - bls: butil.c:273-0 Using device: "FileStorage" for reading. - 22-Jun 19:34 bls JobId 0: Ready to read from volume "TestVolume001" on device "Storage1" (/var/lib/bareos/storage). - Volume Label Record: VolSessionId=1 VolSessionTime=1498152622 JobId=0 DataLen=168 - Begin Job Session Record: VolSessionId=1 VolSessionTime=1498152622 JobId=1 DataLen=169 - FileIndex=1 Stream=1 UATTR DataLen=129 | -rw-rw-r-- 1 root root 5 2017-06-22 19:30:21 - | /srv/data/test1.dat - FileIndex=1 Stream=29 COMPRESSED DataLen=25 | GZIP, level=9, version=1, length=13 - FileIndex=1 Stream=3 MD5 DataLen=16 | 2Oj8otwPiW/Xy0ywAxuiSQ (base64) - FileIndex=2 Stream=1 UATTR DataLen=123 | drwxrwxr-x 2 root root 4096 2017-06-22 19:30:21 - | /srv/data/ + root@host:~# bls FileStorage -V Full-0001 -v + bls: stored/butil.cc:304-0 Using device: "FileStorage" for reading. + 13-Sep 14:43 bls JobId 0: Ready to read from volume "Full-0001" on device "FileStorage" (/var/lib/bareos/storage). + Volume Label Record: VolSessionId=1 VolSessionTime=1663079882 JobId=0 DataLen=184 + Begin Job Session Record: VolSessionId=1 VolSessionTime=1663079882 JobId=1 DataLen=164 + FileIndex=1 Stream=1 UATTR DataLen=86 | -rwxr-xr-x 1 root root 1797 2022-09-13 14:36:48 + | /usr/sbin/bareos + FileIndex=1 Stream=2 DATA DataLen=1797 | + FileIndex=1 Stream=3 MD5 DataLen=16 | rsFZaeL8A6GFsWv2epxcWw (base64) + FileIndex=2 Stream=1 UATTR DataLen=90 | -rwxr-xr-x 1 root root 3430 2022-09-13 14:36:48 + | /usr/sbin/btraceback + FileIndex=2 Stream=2 DATA DataLen=3430 | + FileIndex=2 Stream=3 MD5 DataLen=16 | GatM//3Gz1Z3DbUyHnBGdg (base64) ... - End Job Session Record: VolSessionId=1 VolSessionTime=1498152622 JobId=1 - DataLen=205 - 22-Jun 19:34 bls JobId 0: End of Volume at file 0 on device "FileStorage" (/var/lib/bareos/storage), Volume "TestVolume001" - 22-Jun 19:34 bls JobId 0: End of all volumes. + End Job Session Record: VolSessionId=1 VolSessionTime=1663079882 JobId=1 DataLen=200 + 13-Sep 14:43 bls JobId 0: End of Volume at file 0 on device "FileStorage" (/var/lib/bareos/storage), Volume "Full-0001" + 13-Sep 14:43 bls JobId 0: End of all volumes. End of Physical Medium Record: VolSessionId=0 VolSessionTime=0 JobId=0 DataLen=0 - 9 files and directories found. + 23 files and directories found. + 13-Sep 14:43 bls JobId 0: Releasing device "FileStorage" (/var/lib/bareos/storage). -For details about the Volume format, see \bareosDeveloperGuideStorageMediaOutputFormat. +For details about the Volume format, see :ref:`storage-media-output-format`. Show Label Information ^^^^^^^^^^^^^^^^^^^^^^ @@ -331,23 +342,24 @@ Using the :strong:`-L` the label information of a Volume is shown: .. code-block:: shell-session :caption: bls: show volume label - root@host:~# bls -L /var/lib/bareos/storage/testvol - bls: butil.c:282-0 Using device: "/var/lib/bareos/storage" for reading. - 12-Sep 18:41 bls JobId 0: Ready to read from volume "testvol" on device "FileStorage" (/var/lib/bareos/storage). + root@host:~# bls -L /var/lib/bareos/storage/Full-0001 + bls: stored/butil.cc:304-0 Using device: "/var/lib/bareos/storage" for reading. + 13-Sep 14:40 bls JobId 0: Ready to read from volume "Full-0001" on device "FileStorage" (/var/lib/bareos/storage). Volume Label: - Id : Bareos 0.9 mortal - VerNo : 10 - VolName : File002 + Id : Bareos 2.0 immortal + VerNo : 20 + VolName : Full-0001 PrevVolName : VolFile : 0 LabelType : VOL_LABEL - LabelSize : 147 - PoolName : Default + LabelSize : 184 + PoolName : Full MediaType : File PoolType : Backup - HostName : debian6 - Date label written: 06-Mar-2013 17:21 + HostName : 76c757a344d8 + Date label written: 13-Sep-2022 14:38 + 13-Sep 14:40 bls JobId 0: Releasing device "FileStorage" (/var/lib/bareos/storage). Listing Jobs ^^^^^^^^^^^^ @@ -361,29 +373,25 @@ If you are listing a Volume to determine what Jobs to restore, normally the :str .. code-block:: shell-session :caption: bls: list jobs - root@host:~# bls /var/lib/bareos/storage/testvol -j - bls: butil.c:282-0 Using device: "/var/lib/bareos/storage" for reading. - 12-Sep 18:33 bls JobId 0: Ready to read from volume "testvol" on device "FileStorage" (/var/lib/bareos/storage). - Volume Record: File:blk=0:193 SessId=1 SessTime=1362582744 JobId=0 DataLen=158 - Begin Job Session Record: File:blk=0:64705 SessId=1 SessTime=1362582744 JobId=1 - Job=BackupClient1.2013-03-06_17.22.48_05 Date=06-Mar-2013 17:22:51 Level=F Type=B - End Job Session Record: File:blk=0:6499290 SessId=1 SessTime=1362582744 JobId=1 - Date=06-Mar-2013 17:22:52 Level=F Type=B Files=162 Bytes=6,489,071 Errors=0 Status=T - Begin Job Session Record: File:blk=0:6563802 SessId=2 SessTime=1362582744 JobId=2 - Job=BackupClient1.2013-03-06_23.05.00_02 Date=06-Mar-2013 23:05:02 Level=I Type=B - End Job Session Record: File:blk=0:18832687 SessId=2 SessTime=1362582744 JobId=2 - Date=06-Mar-2013 23:05:02 Level=I Type=B Files=3 Bytes=12,323,791 Errors=0 Status=T - ... - Begin Job Session Record: File:blk=0:319219736 SessId=299 SessTime=1369307832 JobId=454 - Job=BackupClient1.2013-09-11_23.05.00_25 Date=11-Sep-2013 23:05:03 Level=I Type=B - End Job Session Record: File:blk=0:319219736 SessId=299 SessTime=1369307832 JobId=454 - Date=11-Sep-2013 23:05:03 Level=I Type=B Files=0 Bytes=0 Errors=0 Status=T - Begin Job Session Record: File:blk=0:319284248 SessId=301 SessTime=1369307832 JobId=456 - Job=BackupCatalog.2013-09-11_23.10.00_28 Date=11-Sep-2013 23:10:03 Level=F Type=B - End Job Session Record: File:blk=0:320694269 SessId=301 SessTime=1369307832 JobId=456 - Date=11-Sep-2013 23:10:03 Level=F Type=B Files=12 Bytes=1,472,681 Errors=0 Status=T - 12-Sep 18:32 bls JobId 0: End of Volume at file 0 on device "FileStorage" (/var/lib/bareos/storage), Volume "testvol" - 12-Sep 18:32 bls JobId 0: End of all volumes. + root@host:~# bls FileStorage -V Full-0001 -j + bls: stored/butil.cc:304-0 Using device: "FileStorage" for reading. + 13-Sep 14:56 bls JobId 0: Ready to read from volume "Full-0001" on device "FileStorage" (/var/lib/bareos/storage). + Volume Record: File:blk=0:219 SessId=1 SessTime=1663079882 JobId=0 DataLen=184 + Begin Job Session Record: File:blk=0:64731 SessId=1 SessTime=1663079882 JobId=1 + Job=backup-bareos-fd.2022-09-13_14.38.22_03 Date=13-Sep-2022 14:38:54 Level=F Type=B + End Job Session Record: File:blk=0:21531986 SessId=1 SessTime=1663079882 JobId=1 + Job=backup-bareos-fd.2022-09-13_14.38.22_03 Date=13-Sep-2022 14:38:55 Level=F Type=B Files=23 Bytes=21,514,771 Errors=0 Status=T + Begin Job Session Record: File:blk=0:21596498 SessId=2 SessTime=1663079882 JobId=2 + Job=BackupCatalog.2022-09-13_14.52.39_05 Date=13-Sep-2022 14:52:57 Level=F Type=B + End Job Session Record: File:blk=0:21632274 SessId=2 SessTime=1663079882 JobId=2 + Job=BackupCatalog.2022-09-13_14.52.39_05 Date=13-Sep-2022 14:52:57 Level=F Type=B Files=83 Bytes=97,574 Errors=0 Status=T + Begin Job Session Record: File:blk=0:21696786 SessId=4 SessTime=1663079882 JobId=4 + Job=backup-bareos-fd.2022-09-13_14.56.13_08 Date=13-Sep-2022 14:56:37 Level=F Type=B + End Job Session Record: File:blk=0:73795419 SessId=4 SessTime=1663079882 JobId=4 + Job=backup-bareos-fd.2022-09-13_14.56.13_08 Date=13-Sep-2022 14:56:38 Level=F Type=B Files=163 Bytes=52,119,713 Errors=0 Status=T + 13-Sep 14:56 bls JobId 0: End of Volume at file 0 on device "FileStorage" (/var/lib/bareos/storage), Volume "Full-0001" + 13-Sep 14:56 bls JobId 0: End of all volumes. + 13-Sep 14:56 bls JobId 0: Releasing device "FileStorage" (/var/lib/bareos/storage). Adding the :strong:`-v` option will display virtually all information that is available for each record. @@ -398,31 +406,41 @@ Normally, except for debugging purposes, you will not need to list Bareos blocks .. code-block:: shell-session - root@host:~# bls -k /tmp/File002 - bls: butil.c:148 Using device: /tmp + root@host:~# bls FileStorage -k -V Incremental-0002 + bls: stored/butil.cc:304-0 Using device: "FileStorage" for reading. + 13-Sep 15:00 bls JobId 0: Ready to read from volume "Incremental-0002" on device "FileStorage" (/var/lib/bareos/storage). + Block: 0 size=234 Block: 1 size=64512 Block: 2 size=64512 ... - Block: 65 size=64512 - Block: 66 size=19195 - bls: Got EOF on device /tmp + Block: 474 size=64512 + Block: 475 size=53141 + 13-Sep 15:00 bls JobId 0: End of file 0 on device "FileStorage" (/var/lib/bareos/storage), Volume "Incremental-0002" + 13-Sep 15:00 bls JobId 0: Got EOM at file 0 on device "FileStorage" (/var/lib/bareos/storage), Volume "Incremental-0002" + 13-Sep 15:00 bls JobId 0: Releasing device "FileStorage" (/var/lib/bareos/storage). End of File on device By adding the :strong:`-v` option, you can get more information, which can be useful in knowing what sessions were written to the volume: .. code-block:: shell-session - root@host:~# bls -k -v /tmp/File002 - Date label written: 2002-10-19 at 21:16 - Block: 1 blen=64512 First rec FI=VOL_LABEL SessId=1 SessTim=1035062102 Strm=0 rlen=147 - Block: 2 blen=64512 First rec FI=6 SessId=1 SessTim=1035062102 Strm=DATA rlen=4087 - Block: 3 blen=64512 First rec FI=12 SessId=1 SessTim=1035062102 Strm=DATA rlen=5902 - Block: 4 blen=64512 First rec FI=19 SessId=1 SessTim=1035062102 Strm=DATA rlen=28382 + root@host:~# bls FileStorage -k -v -V Incremental-0002 + bls: stored/butil.cc:304-0 Using device: "FileStorage" for reading. + 13-Sep 15:00 bls JobId 0: Ready to read from volume "Incremental-0002" on device "FileStorage" (/var/lib/bareos/storage). + File:blk=0:233 blk_num=0 blen=234 First rec FI=VOL_LABEL SessId=3 SessTim=1663079882 Strm=0 rlen=198 + File:blk=0:64745 blk_num=1 blen=64512 First rec FI=SOS_LABEL SessId=3 SessTim=1663079882 Strm=3 rlen=171 + File:blk=0:129257 blk_num=2 blen=64512 First rec FI=7 SessId=3 SessTim=1663079882 Strm=DATA rlen=30338 + File:blk=0:193769 blk_num=3 blen=64512 First rec FI=15 SessId=3 SessTim=1663079882 Strm=DATA rlen=3720 + File:blk=0:258281 blk_num=4 blen=64512 First rec FI=16 SessId=3 SessTim=1663079882 Strm=DATA rlen=4920 + File:blk=0:322793 blk_num=5 blen=64512 First rec FI=17 SessId=3 SessTim=1663079882 Strm=DATA rlen=61718 ... - Block: 65 blen=64512 First rec FI=83 SessId=1 SessTim=1035062102 Strm=DATA rlen=1873 - Block: 66 blen=19195 First rec FI=83 SessId=1 SessTim=1035062102 Strm=DATA rlen=2973 - bls: Got EOF on device /tmp - End of File on device + File:blk=0:30514409 blk_num=473 blen=64512 First rec FI=138 SessId=3 SessTim=1663079882 Strm=DATA rlen=33238 + File:blk=0:30578921 blk_num=474 blen=64512 First rec FI=139 SessId=3 SessTim=1663079882 Strm=DATA rlen=34441 + File:blk=0:30632062 blk_num=475 blen=53141 First rec FI=139 SessId=3 SessTim=1663079882 Strm=DATA rlen=21545 + 13-Sep 15:00 bls JobId 0: End of file 0 on device "FileStorage" (/var/lib/bareos/storage), Volume "Incremental-0002" + 13-Sep 15:00 bls JobId 0: Got EOM at file 0 on device "FileStorage" (/var/lib/bareos/storage), Volume "Incremental-0002" + 13-Sep 15:00 bls JobId 0: Releasing device "FileStorage" (/var/lib/bareos/storage). + Armed with the SessionId and the SessionTime, you can extract just about anything. @@ -430,33 +448,36 @@ If you want to know even more, add a second :strong:`-v` to the command line to .. code-block:: shell-session - root@host:~# bls -k -vv /tmp/File002 - bls: block.c:79 Dump block 80f8ad0: size=64512 BlkNum=1 - Hdrcksum=b1bdfd6d cksum=b1bdfd6d - bls: block.c:92 Rec: VId=1 VT=1035062102 FI=VOL_LABEL Strm=0 len=147 p=80f8b40 - bls: block.c:92 Rec: VId=1 VT=1035062102 FI=SOS_LABEL Strm=-7 len=122 p=80f8be7 - bls: block.c:92 Rec: VId=1 VT=1035062102 FI=1 Strm=UATTR len=86 p=80f8c75 - bls: block.c:92 Rec: VId=1 VT=1035062102 FI=2 Strm=UATTR len=90 p=80f8cdf - bls: block.c:92 Rec: VId=1 VT=1035062102 FI=3 Strm=UATTR len=92 p=80f8d4d - bls: block.c:92 Rec: VId=1 VT=1035062102 FI=3 Strm=DATA len=54 p=80f8dbd - bls: block.c:92 Rec: VId=1 VT=1035062102 FI=3 Strm=MD5 len=16 p=80f8e07 - bls: block.c:92 Rec: VId=1 VT=1035062102 FI=4 Strm=UATTR len=98 p=80f8e2b - bls: block.c:92 Rec: VId=1 VT=1035062102 FI=4 Strm=DATA len=16 p=80f8ea1 - bls: block.c:92 Rec: VId=1 VT=1035062102 FI=4 Strm=MD5 len=16 p=80f8ec5 - bls: block.c:92 Rec: VId=1 VT=1035062102 FI=5 Strm=UATTR len=96 p=80f8ee9 - bls: block.c:92 Rec: VId=1 VT=1035062102 FI=5 Strm=DATA len=1783 p=80f8f5d - bls: block.c:92 Rec: VId=1 VT=1035062102 FI=5 Strm=MD5 len=16 p=80f9668 - bls: block.c:92 Rec: VId=1 VT=1035062102 FI=6 Strm=UATTR len=95 p=80f968c - bls: block.c:92 Rec: VId=1 VT=1035062102 FI=6 Strm=DATA len=32768 p=80f96ff - bls: block.c:92 Rec: VId=1 VT=1035062102 FI=6 Strm=DATA len=32768 p=8101713 - bls: block.c:79 Dump block 80f8ad0: size=64512 BlkNum=2 - Hdrcksum=9acc1e7f cksum=9acc1e7f - bls: block.c:92 Rec: VId=1 VT=1035062102 FI=6 Strm=contDATA len=4087 p=80f8b40 - bls: block.c:92 Rec: VId=1 VT=1035062102 FI=6 Strm=DATA len=31970 p=80f9b4b - bls: block.c:92 Rec: VId=1 VT=1035062102 FI=6 Strm=MD5 len=16 p=8101841 + root@host:~# bls -k -vv /var/lib/bareos/storage/Incremental-0002 + bls: stored/butil.cc:304-0 Using device: "/var/lib/bareos/storage" for reading. + 13-Sep 15:04 bls JobId 0: Ready to read from volume "Incremental-0002" on device "FileStorage" (/var/lib/bareos/storage). + bls: stored/block.cc:99-0 Dump block 24ac278: size=234 BlkNum=0 + Hdrcksum=2fce7bf9 cksum=2fce7bf9 + bls: stored/block.cc:112-0 Rec: VId=3 VT=1663079882 FI=VOL_LABEL Strm=0 len=198 p=24ae670 + bls: stored/block.cc:112-0 Rec: VId=3 VT=1663079882 FI=1659628785 Strm=64512 len=1 p=24ae742 + bls: stored/block.cc:99-0 Dump block 24ac278: size=64512 BlkNum=1 + Hdrcksum=62ebecf1 cksum=62ebecf1 + bls: stored/block.cc:112-0 Rec: VId=3 VT=1663079882 FI=SOS_LABEL Strm=3 len=171 p=24ae670 + bls: stored/block.cc:112-0 Rec: VId=3 VT=1663079882 FI=1 Strm=UATTR len=96 p=24ae727 + bls: stored/block.cc:112-0 Rec: VId=3 VT=1663079882 FI=2 Strm=UATTR len=94 p=24ae793 + bls: stored/block.cc:112-0 Rec: VId=3 VT=1663079882 FI=3 Strm=UATTR len=88 p=24ae7fd + bls: stored/block.cc:112-0 Rec: VId=3 VT=1663079882 FI=3 Strm=DATA len=1288 p=24ae861 + bls: stored/block.cc:112-0 Rec: VId=3 VT=1663079882 FI=3 Strm=MD5 len=16 p=24aed75 + bls: stored/block.cc:112-0 Rec: VId=3 VT=1663079882 FI=4 Strm=UATTR len=87 p=24aed91 + bls: stored/block.cc:112-0 Rec: VId=3 VT=1663079882 FI=4 Strm=DATA len=1671 p=24aedf4 + bls: stored/block.cc:112-0 Rec: VId=3 VT=1663079882 FI=4 Strm=MD5 len=16 p=24af487 + bls: stored/block.cc:112-0 Rec: VId=3 VT=1663079882 FI=5 Strm=UATTR len=92 p=24af4a3 + bls: stored/block.cc:112-0 Rec: VId=3 VT=1663079882 FI=5 Strm=DATA len=3075 p=24af50b + bls: stored/block.cc:112-0 Rec: VId=3 VT=1663079882 FI=5 Strm=MD5 len=16 p=24b011a + bls: stored/block.cc:112-0 Rec: VId=3 VT=1663079882 FI=6 Strm=UATTR len=88 p=24b0136 + bls: stored/block.cc:112-0 Rec: VId=3 VT=1663079882 FI=6 Strm=DATA len=22776 p=24b019a + bls: stored/block.cc:112-0 Rec: VId=3 VT=1663079882 FI=6 Strm=MD5 len=16 p=24b5a9e + bls: stored/block.cc:112-0 Rec: VId=3 VT=1663079882 FI=7 Strm=UATTR len=88 p=24b5aba + bls: stored/block.cc:112-0 Rec: VId=3 VT=1663079882 FI=7 Strm=DATA len=64944 p=24b5b1e + bls: stored/block.cc:99-0 Dump block 24ac278: size=64512 BlkNum=2 + Hdrcksum=ec9afd49 cksum=ec9afd49 ... - .. _bextract: bextract @@ -480,7 +501,7 @@ Please note that some of the current limitations of :command:`bextract` are: #. The command line length is relatively limited, which means that you cannot enter a huge number of volumes. If you need to enter more volumes than the command line supports, please use a bootstrap file (see below). #. Extracting files from a Windows backup on a Linux system will only extract the plain files, not the additional Windows file information. If you have to extract files from a Windows backup, you should use the Windows version of :command:`bextract`. - + .. literalinclude:: /include/autogenerated/usage/bextract.txt @@ -592,7 +613,7 @@ It is called: .. literalinclude:: /include/autogenerated/usage/bscan.txt - + If you have provided security on your database, you may need to supply either the database name (-b option), the user name (-u option), and/or the password (-p) options. NOTE: before :command:`bscan` can work, it needs at least a bare bones valid database. If your database exists but some records are missing because they were pruned, then you are all set. If your database was lost or destroyed, then you must first ensure that you have PostgreSQL running, then you must create the Bareos database (normally named bareos), and you must create the Bareos tables. This is explained in :ref:`section-CreateDatabase` @@ -781,10 +802,10 @@ bcopy singe: Command; bcopy The :command:`bcopy` program can be used to copy one Bareos archive file to another. For example, you may copy a tape to a file, a file to a tape, a file to a file, or a tape to a tape. For tape to tape, you will need two tape drives. In the process of making the copy, no record of the information written to the new Volume is stored in the catalog. This means that the new Volume, though it contains valid backup data, cannot be accessed directly from existing catalog entries. If you -wish to be able to use the Volume with the Console restore command, for example, you must first bscan the new Volume into the catalog. +wish to be able to use the Volume with the Console restore command, for example, you must first command:`bscan` the new Volume into the catalog. .. literalinclude:: /include/autogenerated/usage/bcopy.txt - + By using a bootstrap file, you can copy parts of a Bareos archive file to another archive. @@ -797,23 +818,24 @@ btape single: btape single: Command; btape -This program permits a number of elementary tape operations via a tty command interface. It works only with tapes and not with other kinds of Bareos storage media (DVD, File, ...). The test command, described below, can be very useful for testing older tape drive compatibility problems. Aside from initial testing of tape drive compatibility with Bareos, btape will be mostly used by developers writing new tape drivers. +This program permits a number of elementary tape operations via a tty command interface. It works only with tapes and not with other kinds of Bareos storage media (DVD, File, ...). The test command, described below, can be very useful for testing older tape drive compatibility problems. Aside from initial testing of tape drive compatibility with Bareos, command:`btape` will be mostly used by developers writing new tape drivers. -btape can be dangerous to use with existing Bareos tapes because it will relabel a tape or write on the tape if so requested regardless that the tape may contain valuable data, so please be careful and use it only on blank tapes. +command:`btape` can be dangerous to use with existing Bareos tapes because it will relabel a tape or write on the tape if so requested regardless that the tape may contain valuable data, so please be careful and use it only on blank tapes. -To work properly, :command:`btape` needs to read the Storage daemon’s configuration file. +To work properly, :command:`btape` needs to read the Storage daemon’s configuration. -The physical device name must be specified on the command line, and this same device name must be present in the Storage daemon’s configuration file read by :command:`btape`. +The physical device name must be specified on the command line, and this same device name must be present in the Storage daemon’s configuration read by :command:`btape`. .. literalinclude:: /include/autogenerated/usage/btape.txt - + Using btape to Verify your Tape Drive ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -:index:`\ <single: Drive; Verify using btape>`\ +.. index:: + single: Drive; Verify using btape -An important reason for this program is to ensure that a Storage daemon configuration file is defined so that Bareos will correctly read and write tapes. +An important reason for this program is to ensure that a Storage daemon configuration is defined so that Bareos will correctly read and write tapes. It is highly recommended that you run the test command before running your first Bareos job to ensure that the parameters you have defined for your storage device (tape drive) will permit Bareos to function properly. You only need to mount a blank tape, enter the command, and the output should be reasonably self explanatory. Please see the :ref:`Tape Testing <TapeTestingChapter>` Chapter of this manual for the details. @@ -825,36 +847,36 @@ The full list of commands are: .. code-block:: bconsole :caption: btape commands - Command Description - ======= =========== + Command Description + ======= =========== autochanger test autochanger - bsf backspace file - bsr backspace record - cap list device capabilities - clear clear tape errors - eod go to end of Bareos data for append - eom go to the physical end of medium - fill fill tape, write onto second volume - unfill read filled tape - fsf forward space a file - fsr forward space a record - help print this command - label write a Bareos label to the tape - load load a tape - quit quit btape - rawfill use write() to fill tape - readlabel read and print the Bareos tape label - rectest test record handling functions - rewind rewind the tape - scan read() tape block by block to EOT and report - scanblocks Bareos read block by block to EOT and report - speed report drive speed - status print tape status - test General test Bareos tape functions - weof write an EOF on the tape - wr write a single Bareos block - rr read a single record - qfill quick fill command + bsf backspace file + bsr backspace record + cap list device capabilities + clear clear tape errors + eod go to end of Bareos data for append + eom go to the physical end of medium + fill fill tape, write onto second volume + unfill read filled tape + fsf forward space a file + fsr forward space a record + help print this command + label write a Bareos label to the tape + load load a tape + quit quit btape + rawfill use write() to fill tape + readlabel read and print the Bareos tape label + rectest test record handling functions + rewind rewind the tape + scan read() tape block by block to EOT and report + scanblocks Bareos read block by block to EOT and report + speed report drive speed + status print tape status + test General test Bareos tape functions + weof write an EOF on the tape + wr write a single Bareos block + rr read a single record + qfill quick fill command The most useful commands are: @@ -872,28 +894,31 @@ In the event that you want to relabel a Bareos volume, you can simply use the la .. _section-btapespeed: -Testing your Tape Drive -''''''''''''''''''''''' +Testing your Tape Drive Speed +''''''''''''''''''''''''''''' -To determine the best configuration of your tape drive, you can run the new ``speed`` command available in the ``btape`` program. +To determine the best configuration of your tape drive, you can run the ``speed`` command available in the :command:`btape` program. This command can have the following arguments: -- Specify the :config:option:`sd/device/MaximumFileSize`\ for this test. This counter is in GB. +- ``file_size`` specify the file size for this test. This counter is in GB. + +- ``nb_file`` specify the number of file to be written. The amount of data should be greater than your memory (``file_size`` * ``nb_file``). -- Specify the number of file to be written. The amount of data should be greater than your memory (file_size * nb_file). +- ``skip_raw`` flag permits to skip tests with raw access. -- This flag permits to skip tests with constant data. +- ``skip_block`` flag permits to skip tests with Bareos block access. -- This flag permits to skip tests with random data. +- ``skip_zero`` flag permits to skip tests with constant data. -- This flag permits to skip tests with raw access. +- ``skip_random`` flag permits to skip tests with random data. -- This flag permits to skip tests with Bareos block access. .. code-block:: bconsole :caption: btape speed + su bareos -g bareos -G tape -s /bin/sh -c '/usr/sbin/btape Drive-0' + *speed file_size=3 skip_raw btape.c:1078 Test with zero data and Bareos block structure. btape.c:956 Begin writing 3 files of 3.221 GB with blocks of 129024 bytes. @@ -912,9 +937,11 @@ This command can have the following arguments: ... btape.c:383 Total Volume bytes=9.664 GB. Total Write rate = 7.365 MB/s -When using compression, the random test will give your the minimum throughput of your drive . The test using constant string will give you the maximum speed of your hardware chain. (cpu, memory, scsi card, cable, drive, tape). -You can change the block size in the Storage Daemon configuration file. +When using compression, the random test will give you the minimum throughput of your drive. +The test using constant string will give you the maximum speed of your hardware chain. (cpu, memory, scsi card, cable, drive, tape). + +You can change the block size in the Storage Daemon configuration file. see :config:option:`sd/device/MaximumBlockSize` .. _bscrypto: @@ -922,7 +949,9 @@ You can change the block size in the Storage Daemon configuration file. bscrypto ~~~~~~~~ -:index:`\ <single: bscrypto>`\ :index:`\ <single: Command; bscrypto>`\ +.. index:: + single: bscrypto + single: Command; bscrypto :command:`bscrypto` is used in the process of encrypting tapes (see also :ref:`LTOHardwareEncryptionGeneral`). The |sd| and the btools (:command:`bls`, :command:`bextract`, :command:`bscan`, :command:`btape`, :command:`bextract`) will use a so called |sd| plugin to perform the setting and clearing of the encryption keys. To bootstrap the encryption support and for populating things like the crypto cache with encryption keys of volumes that you want to scan, you need to use the bscrypto tool. The bscrypto tool has the following capabilities: @@ -947,7 +976,7 @@ populating things like the crypto cache with encryption keys of volumes that you - | show the content of a wrapped or unwrapped keyfile. | This can be used to reveal the content of the passphrase when a passphrase is stored in the database and you have the urge to change the Key Encryption Key. Normally it is unwise to change the Key Encryption Key, as this means that you have to redo all your stored encryption keys, as they are stored in the database wrapped using the Key Encryption Key available in the config during the label phase of the volume. -- Clear the crypto cache on the machine running the bareos-sd, which keeps a cache of used encryption keys, which can be used when the bareos-sd is restarted without the need to connect to the bareos-dir to retrieve the encryption keys. +- Clear the crypto cache on the machine running the |sd|, which keeps a cache of used encryption keys, which can be used when the |sd| is restarted without the need to connect to the |dir| to retrieve the encryption keys. - Set the encryption key of the drive @@ -959,6 +988,7 @@ populating things like the crypto cache with encryption keys of volumes that you - Populate the crypto cache with data + Other Programs -------------- @@ -970,34 +1000,19 @@ The following programs are general utility programs and in general do not need a bsmtp ~~~~~ -:index:`\ <single: bsmtp>`\ :index:`\ <single: Command; bsmtp>`\ +.. index:: + single: bsmtp + single: Command; bsmtp :command:`bsmtp` is a simple mail transport program that permits more flexibility than the standard mail programs typically found on Unix systems. It can even be used on Windows machines. It is called: -.. code-block:: shell-session - :caption: bsmtp - - Usage: bsmtp [-f from] [-h mailhost] [-s subject] [-c copy] [recipient ...] - -4 forces bsmtp to use IPv4 addresses only. - -6 forces bsmtp to use IPv6 addresses only. - -8 set charset to UTF-8 - -a use any ip protocol for address resolution - -c set the Cc: field - -d <nn> set debug level to <nn> - -dt print a timestamp in debug output - -f set the From: field - -h use mailhost:port as the SMTP server - -s set the Subject: field - -r set the Reply-To: field - -l set the maximum number of lines to send (default: unlimited) - -? print this message. +.. literalinclude:: /include/autogenerated/usage/bsmtp.txt If the -f option is not specified, :command:`bsmtp` will use your userid. If the option -h is not specified :command:`bsmtp` will use the value in the environment variable bsmtpSERVER or if there is none localhost. By default port 25 is used. -If a line count limit is set with the -l option, :command:`bsmtp` will not send an email with a body text exceeding that number of lines. This is especially useful for large restore job reports where the list of files restored might produce very long mails your mail-server would refuse or crash. However, be aware that you will probably suppress the job report and any error messages unless you check the log file written by the Director (see the messages resource in this manual for -details). +If a line count limit is set with the -l option, :command:`bsmtp` will not send an email with a body text exceeding that number of lines. This is especially useful for large restore job reports where the list of files restored might produce very long mails your mail-server would refuse or crash. However, be aware that you will probably suppress the job report and any error messages unless you check the log file written by the Director (see the messages resource in this manual for details). recipients is a space separated list of email recipients. @@ -1013,14 +1028,13 @@ An example of the use of :command:`bsmtp` would be to put the following statemen You have to replace mail.example.com with the fully qualified name of your SMTP (email) server, which normally listens on port 25. For more details on the substitution characters (e.g. %r) used in the above line, please see the documentation of the :ref:`MailCommand in the Messages Resource <mailcommand>` chapter of this manual. -It is HIGHLY recommended that you test one or two cases by hand to make sure that the mailhost that you specified is correct and that it will accept your email requests. Since bsmtp always uses a TCP connection rather than writing in the spool file, you may find that your from address is being rejected because it does not contain a valid domain, or because your message is caught in your spam filtering rules. Generally, you should specify a fully qualified domain name in the from field, and -depending on whether your bsmtp gateway is Exim or Sendmail, you may need to modify the syntax of the from part of the message. Please test. +It is HIGHLY recommended that you test one or two cases by hand to make sure that the `mailhost` that you specified is correct and that it will accept your email requests. Since command:`bsmtp` always uses a TCP connection rather than writing in the spool file, you may find that your `from address` is being rejected because it does not contain a valid domain, or because your message is caught in your spam filtering rules. Generally, you should specify a fully qualified domain name in the from field, and depending on whether your `bsmtp gateway` is `Exim` or `Sendmail`, you may need to modify the syntax of the from part of the message. Please test. -When running :command:`bsmtp` by hand, you will need to terminate the message by entering a ctrl-d in column 1 of the last line. +When running :command:`bsmtp` by hand, you will need to terminate the message by entering a `ctrl-d` in column 1 of the last line. If you are getting incorrect dates (e.g. 1970) and you are running with a non-English language setting, you might try adding a :command:`LANG=C` immediately before the :command:`bsmtp` call. -In general, :command:`bsmtp` attempts to cleanup email addresses that you specify in the from, copy, mailhost, and recipient fields, by adding the necessary < and > characters around the address part. However, if you include a display-name (see RFC 5332), some SMTP servers such as Exchange may not accept the message if the display-name is also included in < and >. As mentioned above, you must test, and if you run into this situation, you may manually add the < and > to the Bareos +In general, :command:`bsmtp` attempts to cleanup email addresses that you specify in the `from`, `copy`, `mailhost`, and recipient fields, by adding the necessary < and > characters around the address part. However, if you include a display-name (see RFC 5332), some SMTP servers such as Exchange may not accept the message if the display-name is also included in < and >. As mentioned above, you must test, and if you run into this situation, you may manually add the < and > to the Bareos :config:option:`dir/messages/MailCommand`\ or :config:option:`dir/messages/OperatorCommand`\ and when :command:`bsmtp` is formatting an address if it already contains a < or > character, it will leave the address unchanged. @@ -1036,8 +1050,7 @@ bareos-dbcheck single: Command; bareos-dbcheck single: Catalog; database check -:command:`bareos-dbcheck` is a simple program that will search for logical inconsistencies in the Bareos tables in your database, and optionally fix them. It is a database maintenance routine, in the sense that it can detect and remove unused rows, but it is not a database repair routine. To repair a database, see the tools furnished by the database vendor. Normally :command:`bareos-dbcheck` should never need to be run, but if Bareos has crashed or you have a lot of -Clients, Pools, or Jobs that you have removed, it could be useful. +:command:`bareos-dbcheck` is a simple program that will search for logical inconsistencies in the Bareos tables in your database, and optionally fix them. It is a database maintenance routine, in the sense that it can detect and remove unused rows, but it is not a database repair routine. To repair a database, see the tools furnished by the database vendor. Normally :command:`bareos-dbcheck` should never need to be run, but if Bareos has crashed or you have a lot of Clients, Pools, or Jobs that you have removed, it could be useful. :command:`bareos-dbcheck` is best started as the same user, as the |dir| is running, normally **bareos**. If you are **root** on Linux, use the following command to switch to user **bareos**: @@ -1050,8 +1063,8 @@ If not, problems of reading the Bareos configuration or accessing the database c :command:`bareos-dbcheck` supports following command line options: -.. literalinclude:: /include/autogenerated/usage/bareos-dbcheck.txt - +.. literalinclude:: /include/autogenerated/usage/bareos-dbcheck.txt + When using the default configuration paths, it is not necessary to specify any options. Optionally, as Bareos supports loading its database backend dynamically you may specify the right database driver to use using the :strong:`-D` option. If the :strong:`-B` option is specified, :command:`bareos-dbcheck` will print out catalog information in a simple text based format: @@ -1143,7 +1156,9 @@ Normally you should never need to run :command:`bareos-dbcheck` in spite of the bregex ~~~~~~ -:index:`\ <single: bregex>`\ :index:`\ <single: Command; bregex>`\ +.. index:: + single: bregex + single: Command; bregex :command:`bregex` is a simple program that will allow you to test regular expressions against a file of data. This can be useful because the regex libraries on most systems differ, and in addition, regex expressions can be complicated. @@ -1162,14 +1177,16 @@ This program can be useful for testing regex expressions to be applied against a bwild ~~~~~ -:index:`\ <single: bwild>`\ :index:`\ <single: Command; bwild>`\ +.. index:: + single: bwild + single: Command; bwild :command:`bwild` is a simple program that will allow you to test wild-card expressions against a file of data. To run it, use: .. literalinclude:: /include/autogenerated/usage/bwild.txt - + The <data-file> is a filename that contains lines of data to be matched (or not) against one or more patterns. When the program is run, it will prompt you for a wild-card pattern, then apply it one line at a time against the data in the file. Each line that matches will be printed preceded by its line number. You will then be prompted again for another pattern. Enter an empty line for a pattern to terminate the program. You can print only lines that do not match by using the -n option, and you can suppress printing of line numbers with the -l option. @@ -1182,10 +1199,16 @@ This program can be useful for testing wild expressions to be applied against a bpluginfo ~~~~~~~~~ -:index:`\ <single: bpluginfo>`\ :index:`\ <single: Command; bpluginfo>`\ +.. index:: + single: bpluginfo + single: Command; bpluginfo The main purpose of bpluginfo is to display different information about Bareos plugin. You can use it to check a plugin name, author, license and short description. You can use -f option to display API implemented by the plugin. Some plugins may require additional ’-a’ option for val- idating a Bareos Daemons API. In most cases it is not required. +To run it, use: + +.. literalinclude:: /include/autogenerated/usage/bpluginfo.txt + .. _program-bareos-dbcopy: .. include:: ../man/bareos-dbcopy.rst diff --git a/docs/manuals/source/DeveloperGuide/mediaformat.rst b/docs/manuals/source/DeveloperGuide/mediaformat.rst index 67675b1b6..8ff7858b7 100644 --- a/docs/manuals/source/DeveloperGuide/mediaformat.rst +++ b/docs/manuals/source/DeveloperGuide/mediaformat.rst @@ -1,3 +1,5 @@ +.. _storage-media-output-format: + Storage Media Output Format =========================== diff --git a/docs/manuals/source/include/autogenerated/usage/bsmtp.txt b/docs/manuals/source/include/autogenerated/usage/bsmtp.txt new file mode 100644 index 000000000..e4e7b13c2 --- /dev/null +++ b/docs/manuals/source/include/autogenerated/usage/bsmtp.txt @@ -0,0 +1,15 @@ +Usage: bsmtp [-f from] [-h mailhost] [-s subject] [-c copy] [recipient ...] + -4 forces bsmtp to use IPv4 addresses only. + -6 forces bsmtp to use IPv6 addresses only. + -8 set charset to UTF-8 + -a use any ip protocol for address resolution + -c set the Cc: field + -d <nn> set debug level to <nn> + -dt print a timestamp in debug output + -f set the From: field + -h use mailhost:port as the SMTP server + -s set the Subject: field + -r set the Reply-To: field + -l set the maximum number of lines to send (default: unlimited) + -? print this message. + diff --git a/docs/manuals/source/man/bareos-dbcopy.rst b/docs/manuals/source/man/bareos-dbcopy.rst index 95eadc4c8..c40b1f7bb 100644 --- a/docs/manuals/source/man/bareos-dbcopy.rst +++ b/docs/manuals/source/man/bareos-dbcopy.rst @@ -1,13 +1,13 @@ bareos-dbcopy -============= +~~~~~~~~~~~~~ Synopsis --------- +^^^^^^^^ **bareos-dbcopy** [*options*] <*sourcecatalog*> <*destinationcatalog*> Description ------------ +^^^^^^^^^^^ :program:`bareos-dbcopy` copies the data of all tables from the Bareos catalog ``<sourcecatalog>`` into the Bareos catalog ``<destinationcatalog>``. @@ -35,7 +35,7 @@ For more information please read the according `<https://docs.bareos.org/>`_ Internal workflow ------------------ +^^^^^^^^^^^^^^^^^ * :program:`bareos-dbcopy` scans both the source and destination database for existing tables and column definitions. @@ -48,7 +48,7 @@ Internal workflow * If a destination table already contains data, then this table is skipped. Options -------- +^^^^^^^ .. program:: bareos-dbcopy |