Dietmar Maurer
cf95f616c5
add missing file docs/api-viewer/index.html
2021-02-21 10:04:23 +01:00
Dietmar Maurer
1adbc7c13c
docs: install API viewer
2021-02-21 09:06:58 +01:00
Dietmar Maurer
9d28974c27
adopt PVEAPI.js for PBS, rename to PBSAPI.js
2021-02-21 09:06:58 +01:00
Dietmar Maurer
3dbc35b5c1
copy api-viewer from pve-docs
2021-02-21 09:06:58 +01:00
Dietmar Maurer
7ca0ba4515
tape: add tape-job.cfg manual page
2021-02-15 07:05:39 +01:00
Thomas Lamprecht
70dc2ff3ab
docs/barcode: eslint auto-fixes
...
Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
2021-02-13 14:49:16 +01:00
Dietmar Maurer
81f5d03e8d
docs: update benchmark results
2021-02-13 10:52:19 +01:00
Dietmar Maurer
28eaff20bd
docs: fix target refs in user-management.rst
2021-02-13 10:23:02 +01:00
Dietmar Maurer
8d1a1b2976
docs: conv.py - add man pages to exclude_patterns
...
To avoid sphinx warnings.
2021-02-13 10:16:41 +01:00
Dietmar Maurer
92eaec53db
docs: add proxmox-backup service description
2021-02-13 09:48:21 +01:00
Dietmar Maurer
b3c2c57897
docs: add services.rst to section sysadmin
2021-02-13 09:40:36 +01:00
Dietmar Maurer
f458e97fda
docs: split out output-format.rst
2021-02-13 08:54:23 +01:00
Dietmar Maurer
80bf9ae99b
docs: add short descriptions for main binaries.
2021-02-13 08:43:54 +01:00
Dietmar Maurer
bebd4a7ca4
tape: generate proxmox-tape.1 manual page
2021-02-12 18:00:01 +01:00
Dietmar Maurer
9468e94412
tape: add pmt and pmtx command to tape-backup.rst
2021-02-12 17:45:55 +01:00
Dietmar Maurer
6b66c8507f
lto-barcode: fix page offset calibration
2021-02-12 13:34:19 +01:00
Dietmar Maurer
167e5406c3
Makefile: fix typo (s/madia-pool/media-pool/)
2021-02-12 12:18:25 +01:00
Dietmar Maurer
c111c9a931
tape: add manual page for tape.cfg
2021-02-12 12:09:08 +01:00
Dietmar Maurer
bb71e3a023
tape: add manual page for media-pool.cfg
2021-02-12 11:50:56 +01:00
Dietmar Maurer
96bcfb9b1f
docs: add hint how to edit/modify the datastore.cfg file
2021-02-11 14:20:16 +01:00
Dietmar Maurer
5b7f44555e
docs: add manual page for verification.cfg
2021-02-11 13:40:11 +01:00
Dietmar Maurer
2ca396c015
docs: add manual page for acl.cfg
2021-02-11 13:13:34 +01:00
Dietmar Maurer
d8dae16035
docs: add manual page fro sysc.cfg
2021-02-11 11:52:37 +01:00
Dietmar Maurer
6279b8f5a5
docs: add manukal page for remote.cfg
2021-02-11 11:25:15 +01:00
Dietmar Maurer
67cc79ec52
docs: add user.cfg.5 manual page
2021-02-10 16:51:05 +01:00
Dietmar Maurer
b9a09a9501
docs: add "Configuration Files" appendix
2021-02-10 11:28:56 +01:00
Dietmar Maurer
4a0d3a3e3f
docs: add datastore.cfg.5 man page
2021-02-10 11:05:02 +01:00
Dietmar Maurer
6477ebcf6f
copyright: adopt year
2021-02-10 09:56:33 +01:00
Dietmar Maurer
b22a9c14a4
docs: disable smartquotes
2021-02-09 08:36:09 +01:00
Dietmar Maurer
73a1da5ed6
pmt: document driver options
2021-02-08 08:34:31 +01:00
Dietmar Maurer
fbf8779388
doc: improve pmt/pmtx manual pages
2021-02-06 16:50:56 +01:00
Dietmar Maurer
3231c35fb8
doc: fix problems in pxar manual page
...
- Avoid doubled title (Description/Description)
- Avoid error with sphinx :ref: role
2021-02-06 16:21:36 +01:00
Aaron Lauterer
777690a121
docs/scanrefs: fix handling if ref is same as headline
...
If the ref is named the same as the headline (once normalized), sphinx
will return a 'idX' value in node['ids'][1] which we use for the label
ID. The headline is always present at index 0.
Checking for that and using index 0 in case we do get a 'idX' helps us
to avoid using the 'idX' as keys in our OnlineHelpInfo.js and actually
use the intended key.
Signed-off-by: Aaron Lauterer <a.lauterer@proxmox.com>
2021-02-06 07:49:21 +01:00
Aaron Lauterer
a98e228766
docs: fix references to changed refs
...
With commit ec1ae7e631
some refs were
changed by getting prefixes and such. We need to adapt the places that
reference them as well
Signed-off-by: Aaron Lauterer <a.lauterer@proxmox.com>
2021-02-06 07:47:56 +01:00
Dietmar Maurer
085655b21b
Merge branch 'master' of ssh://proxdev.maurer-it.com/rust/proxmox-backup
2021-02-05 12:53:43 +01:00
Dietmar Maurer
4c209d6b10
install pmt binary
2021-02-05 12:42:20 +01:00
Thomas Lamprecht
ec1ae7e631
docs/online-help: prefix some refs with their chapter name
...
and fix some issues from referenced named the same as their heading
they anchor too.
This should be fixed for real in our python plugin to scan for such
references, its probably a bug there, but as most of the problematic
ones where wrong (missing chapter prefix) anyway changing them is OK
too.
Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
2021-02-05 11:42:06 +01:00
Thomas Lamprecht
02dce8cad0
docs: index: update copyright years
...
Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
2021-02-04 16:06:38 +01:00
Thomas Lamprecht
efc09f63cc
docs: tech overview: avoid 'we' and other small style fixes/additions
...
"we" should be avoided, it's never quite clear who is "we" in the
context here and it leads to some technical wrong meanings, e.g., we
(here assumed to be "we developers") do not read any backup data, the
Proxmox Backup client does.
Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
2021-02-04 12:27:14 +01:00
Thomas Lamprecht
3253d8a2e4
docs: tech overfiew: fix line length
...
Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
2021-02-04 12:05:27 +01:00
Dominik Csapak
1531185dd0
docs: explain some technical details about datastores/chunks
...
adds explanations for:
* what datastores are
* their relation with snapshots/chunks
* basic information about chunk directory structures
* fixed-/dynamically-sized chunks
* special handling of encrypted chunks
* hash collision probability
* limitation of file-based backups
Signed-off-by: Dominik Csapak <d.csapak@proxmox.com>
2021-02-04 11:30:42 +01:00
Thomas Lamprecht
04cec92e8d
update copyright years
...
Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
2021-02-03 12:04:27 +01:00
Thomas Lamprecht
2f617a4548
docs: tfa: add screenshots
...
Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
2021-02-03 10:36:18 +01:00
Thomas Lamprecht
f9fcac51a5
docs: add initial TFA documentation
...
better than nothing..
Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
2021-02-01 19:46:24 +01:00
Dominik Csapak
627d000098
tape: change changer-drive-id to changer-drivenum
...
because it changed in the config
Signed-off-by: Dominik Csapak <d.csapak@proxmox.com>
2021-01-28 15:11:22 +01:00
Dietmar Maurer
b2fc6f9228
fix build: commit missing file
2021-01-27 18:13:58 +01:00
Dietmar Maurer
b06edeca02
remove generated file synopsis.rst (no need to track in git)
2021-01-27 12:38:02 +01:00
Dietmar Maurer
c972704477
install pmtx binary
2021-01-27 11:36:15 +01:00
Dominik Csapak
66d066964c
docs/tape: fix some typos and improve wording
...
Signed-off-by: Dominik Csapak <d.csapak@proxmox.com>
2021-01-26 12:39:06 +01:00
Dietmar Maurer
8ba47929a0
tape: add docu about paperkey
2021-01-23 15:34:28 +01:00