Reorganize and update CLI tool references pages for 4.0

Requested by: QubesOS/qubes-issues#3495
Requests:     QubesOS/qubes-issues#3538
This commit is contained in:
Andrew David Wong 2018-02-04 17:32:30 -06:00
parent 0c29e05f3d
commit 35b02c848c
No known key found for this signature in database
GPG Key ID: 8CE137352A019A17
38 changed files with 186 additions and 84 deletions

6
doc.md
View File

@ -176,8 +176,10 @@ Troubleshooting
Reference Pages
---------------
* [Dom0 Command-Line Tools](/doc/dom0-tools/)
* [DomU Command-Line Tools](/doc/vm-tools/)
* [Command-Line Tools: Qubes 3.2, dom0](/doc/tools/3.2/dom0/)
* [Command-Line Tools: Qubes 3.2, domU](/doc/tools/3.2/domU/)
* [Command-Line Tools: Qubes 4.0, dom0](/doc/tools/4.0/dom0/)
* [Command-Line Tools: Qubes 4.0, domU](/doc/tools/4.0/domU/)
* [Glossary of Qubes Terminology](/doc/glossary/)
* [Qubes Service Framework](/doc/qubes-service/)
* [Command Execution in VMs (and Qubes RPC)](/doc/qrexec/)

View File

@ -1,37 +0,0 @@
---
layout: doc
title: Dom0 Tools
permalink: /doc/dom0-tools/
redirect_from:
- /en/doc/dom0-tools/
- /doc/DomZeroTools/
- /wiki/DomZeroTools/
---
QVM-tools:
- [qubes-dom0-update](/doc/dom0-tools/qubes-dom0-update/)
- [qubes-prefs](/doc/dom0-tools/qubes-prefs/)
- [qvm-add-appvm](/doc/dom0-tools/qvm-add-appvm/)
- [qvm-add-template](/doc/dom0-tools/qvm-add-template/)
- [qvm-backup-restore](/doc/dom0-tools/qvm-backup-restore/)
- [qvm-backup](/doc/dom0-tools/qvm-backup/)
- [qvm-block](/doc/dom0-tools/qvm-block/)
- [qvm-clone](/doc/dom0-tools/qvm-clone/)
- [qvm-create-default-dvm](/doc/dom0-tools/qvm-create-default-dvm/)
- [qvm-create](/doc/dom0-tools/qvm-create/)
- [qvm-firewall](/doc/dom0-tools/qvm-firewall/)
- [qvm-grow-private](/doc/dom0-tools/qvm-grow-private/)
- [qvm-ls](/doc/dom0-tools/qvm-ls/)
- [qvm-kill](/doc/dom0-tools/qvm-kill/)
- [qvm-pci](/doc/dom0-tools/qvm-pci/)
- [qvm-prefs](/doc/dom0-tools/qvm-prefs/)
- [qvm-remove](/doc/dom0-tools/qvm-remove/)
- [qvm-revert-template-changes](/doc/dom0-tools/qvm-revert-template-changes/)
- [qvm-run](/doc/dom0-tools/qvm-run/)
- [qvm-service](/doc/dom0-tools/qvm-service/)
- [qvm-shutdown](/doc/dom0-tools/qvm-shutdown/)
- [qvm-start](/doc/dom0-tools/qvm-start/)
- [qvm-sync-appmenus](/doc/dom0-tools/qvm-sync-appmenus/)
- [qvm-template-commit](/doc/dom0-tools/qvm-template-commit/)

13
reference/tools.md Normal file
View File

@ -0,0 +1,13 @@
---
layout: doc
title: Command-Line Tools
permalink: /doc/tools/
---
Command-Line Tools
==================
Please see the page for your version of Qubes OS:
* [Qubes 4.0 Command-Line Tools](/doc/tools/4.0)
* [Qubes 3.2 Command-Line Tools](/doc/tools/3.2)

View File

@ -0,0 +1,39 @@
---
layout: doc
title: Dom0 Command-Line Tools for Qubes 3.2
permalink: /doc/tools/3.2/dom0/
redirect_from:
- /doc/tools/3.2/dom0/
- /en/doc/tools/3.2/dom0/
- /doc/DomZeroTools/
- /wiki/DomZeroTools/
---
Dom0 Command-Line Tools for Qubes 3.2
=====================================
* [qubes-dom0-update](/doc/tools/3.2/dom0/qubes-dom0-update/)
* [qubes-prefs](/doc/tools/3.2/dom0/qubes-prefs/)
* [qvm-add-appvm](/doc/tools/3.2/dom0/qvm-add-appvm/)
* [qvm-add-template](/doc/tools/3.2/dom0/qvm-add-template/)
* [qvm-backup-restore](/doc/tools/3.2/dom0/qvm-backup-restore/)
* [qvm-backup](/doc/tools/3.2/dom0/qvm-backup/)
* [qvm-block](/doc/tools/3.2/dom0/qvm-block/)
* [qvm-clone](/doc/tools/3.2/dom0/qvm-clone/)
* [qvm-create-default-dvm](/doc/tools/3.2/dom0/qvm-create-default-dvm/)
* [qvm-create](/doc/tools/3.2/dom0/qvm-create/)
* [qvm-firewall](/doc/tools/3.2/dom0/qvm-firewall/)
* [qvm-grow-private](/doc/tools/3.2/dom0/qvm-grow-private/)
* [qvm-ls](/doc/tools/3.2/dom0/qvm-ls/)
* [qvm-kill](/doc/tools/3.2/dom0/qvm-kill/)
* [qvm-pci](/doc/tools/3.2/dom0/qvm-pci/)
* [qvm-prefs](/doc/tools/3.2/dom0/qvm-prefs/)
* [qvm-remove](/doc/tools/3.2/dom0/qvm-remove/)
* [qvm-revert-template-changes](/doc/tools/3.2/dom0/qvm-revert-template-changes/)
* [qvm-run](/doc/tools/3.2/dom0/qvm-run/)
* [qvm-service](/doc/tools/3.2/dom0/qvm-service/)
* [qvm-shutdown](/doc/tools/3.2/dom0/qvm-shutdown/)
* [qvm-start](/doc/tools/3.2/dom0/qvm-start/)
* [qvm-sync-appmenus](/doc/tools/3.2/dom0/qvm-sync-appmenus/)
* [qvm-template-commit](/doc/tools/3.2/dom0/qvm-template-commit/)

View File

@ -1,8 +1,9 @@
---
layout: doc
title: qubes-dom0-update
permalink: /doc/dom0-tools/qubes-dom0-update/
permalink: /doc/tools/3.2/dom0/qubes-dom0-update/
redirect_from:
- /doc/dom0-tools/qubes-dom0-update/
- /en/doc/dom0-tools/qubes-dom0-update/
- /doc/Dom0Tools/QubesDom0Update/
- /wiki/Dom0Tools/QubesDom0Update/

View File

@ -1,8 +1,9 @@
---
layout: doc
title: qubes-prefs
permalink: /doc/dom0-tools/qubes-prefs/
permalink: /doc/tools/3.2/dom0/qubes-prefs/
redirect_from:
- /doc/dom0-tools/qubes-prefs/
- /en/doc/dom0-tools/qubes-prefs/
- /doc/Dom0Tools/QubesPrefs/
- /wiki/Dom0Tools/QubesPrefs/

View File

@ -1,8 +1,9 @@
---
layout: doc
title: qvm-add-appvm
permalink: /doc/dom0-tools/qvm-add-appvm/
permalink: /doc/tools/3.2/dom0/qvm-add-appvm/
redirect_from:
- /doc/dom0-tools/qvm-add-appvm/
- /en/doc/dom0-tools/qvm-add-appvm/
- /doc/Dom0Tools/QvmAddAppvm/
- /wiki/Dom0Tools/QvmAddAppvm/

View File

@ -1,8 +1,9 @@
---
layout: doc
title: qvm-add-template
permalink: /doc/dom0-tools/qvm-add-template/
permalink: /doc/tools/3.2/dom0/qvm-add-template/
redirect_from:
- /doc/dom0-tools/qvm-add-template/
- /en/doc/dom0-tools/qvm-add-template/
- /doc/Dom0Tools/QvmAddTemplate/
- /wiki/Dom0Tools/QvmAddTemplate/

View File

@ -1,8 +1,9 @@
---
layout: doc
title: qvm-backup-restore
permalink: /doc/dom0-tools/qvm-backup-restore/
permalink: /doc/tools/3.2/dom0/qvm-backup-restore/
redirect_from:
- /doc/dom0-tools/qvm-backup-restore/
- /en/doc/dom0-tools/qvm-backup-restore/
- /doc/Dom0Tools/QvmBackupRestore/
- /wiki/Dom0Tools/QvmBackupRestore/

View File

@ -1,8 +1,9 @@
---
layout: doc
title: qvm-backup
permalink: /doc/dom0-tools/qvm-backup/
permalink: /doc/tools/3.2/dom0/qvm-backup/
redirect_from:
- /doc/dom0-tools/qvm-backup/
- /en/doc/dom0-tools/qvm-backup/
- /doc/Dom0Tools/QvmBackup/
- /wiki/Dom0Tools/QvmBackup/

View File

@ -1,8 +1,10 @@
---
layout: doc
title: qvm-block
permalink: /doc/dom0-tools/qvm-block/
permalink: /doc/tools/3.2/dom0/qvm-block/
redirect_from:
- /doc/dom0-tools/qvm-block/
- /doc/dom0-tools/qvm-block/
- /en/doc/dom0-tools/qvm-block/
- /doc/Dom0Tools/QvmBlock/
- /wiki/Dom0Tools/QvmBlock/

View File

@ -1,8 +1,9 @@
---
layout: doc
title: qvm-clone
permalink: /doc/dom0-tools/qvm-clone/
permalink: /doc/tools/3.2/dom0/qvm-clone/
redirect_from:
- /doc/dom0-tools/qvm-clone/
- /en/doc/dom0-tools/qvm-clone/
- /doc/Dom0Tools/QvmClone/
- /wiki/Dom0Tools/QvmClone/

View File

@ -1,8 +1,9 @@
---
layout: doc
title: qvm-create-default-dvm
permalink: /doc/dom0-tools/qvm-create-default-dvm/
permalink: /doc/tools/3.2/dom0/qvm-create-default-dvm/
redirect_from:
- /doc/dom0-tools/qvm-create-default-dvm/
- /en/doc/dom0-tools/qvm-create-default-dvm/
- /doc/Dom0Tools/QvmCreateDefaultDvm/
- /wiki/Dom0Tools/QvmCreateDefaultDvm/

View File

@ -1,8 +1,9 @@
---
layout: doc
title: qvm-create
permalink: /doc/dom0-tools/qvm-create/
permalink: /doc/tools/3.2/dom0/qvm-create/
redirect_from:
- /doc/dom0-tools/qvm-create/
- /en/doc/dom0-tools/qvm-create/
- /doc/Dom0Tools/QvmCreate/
- /wiki/Dom0Tools/QvmCreate/

View File

@ -1,8 +1,9 @@
---
layout: doc
title: qvm-firewall
permalink: /doc/dom0-tools/qvm-firewall/
permalink: /doc/tools/3.2/dom0/qvm-firewall/
redirect_from:
- /doc/dom0-tools/qvm-firewall/
- /en/doc/dom0-tools/qvm-firewall/
- /doc/Dom0Tools/QvmFirewall/
- /wiki/Dom0Tools/QvmFirewall/

View File

@ -1,8 +1,9 @@
---
layout: doc
title: qvm-grow-private
permalink: /doc/dom0-tools/qvm-grow-private/
permalink: /doc/tools/3.2/dom0/qvm-grow-private/
redirect_from:
- /doc/dom0-tools/qvm-grow-private/
- /en/doc/dom0-tools/qvm-grow-private/
- /doc/Dom0Tools/QvmGrowPrivate/
- /wiki/Dom0Tools/QvmGrowPrivate/

View File

@ -1,8 +1,9 @@
---
layout: doc
title: qvm-kill
permalink: /doc/dom0-tools/qvm-kill/
permalink: /doc/tools/3.2/dom0/qvm-kill/
redirect_from:
- /doc/dom0-tools/qvm-kill/
- /en/doc/dom0-tools/qvm-kill/
- /doc/Dom0Tools/QvmKill/
- /wiki/Dom0Tools/QvmKill/

View File

@ -1,8 +1,9 @@
---
layout: doc
title: qvm-ls
permalink: /doc/dom0-tools/qvm-ls/
permalink: /doc/tools/3.2/dom0/qvm-ls/
redirect_from:
- /doc/dom0-tools/qvm-ls/
- /en/doc/dom0-tools/qvm-ls/
- /doc/Dom0Tools/QvmLs/
- /wiki/Dom0Tools/QvmLs/

View File

@ -1,8 +1,9 @@
---
layout: doc
title: qvm-pci
permalink: /doc/dom0-tools/qvm-pci/
permalink: /doc/tools/3.2/dom0/qvm-pci/
redirect_from:
- /doc/dom0-tools/qvm-pci/
- /en/doc/dom0-tools/qvm-pci/
- /doc/Dom0Tools/QvmPci/
- /wiki/Dom0Tools/QvmPci/

View File

@ -1,8 +1,9 @@
---
layout: doc
title: qvm-prefs
permalink: /doc/dom0-tools/qvm-prefs/
permalink: /doc/tools/3.2/dom0/qvm-prefs/
redirect_from:
- /doc/dom0-tools/qvm-prefs/
- /en/doc/dom0-tools/qvm-prefs/
- /doc/Dom0Tools/QvmPrefs/
- /wiki/Dom0Tools/QvmPrefs/

View File

@ -1,8 +1,9 @@
---
layout: doc
title: qvm-remove
permalink: /doc/dom0-tools/qvm-remove/
permalink: /doc/tools/3.2/dom0/qvm-remove/
redirect_from:
- /doc/dom0-tools/qvm-remove/
- /en/doc/dom0-tools/qvm-remove/
- /doc/Dom0Tools/QvmRemove/
- /wiki/Dom0Tools/QvmRemove/

View File

@ -1,8 +1,9 @@
---
layout: doc
title: qvm-revert-template-changes
permalink: /doc/dom0-tools/qvm-revert-template-changes/
permalink: /doc/tools/3.2/dom0/qvm-revert-template-changes/
redirect_from:
- /doc/dom0-tools/qvm-revert-template-changes/
- /en/doc/dom0-tools/qvm-revert-template-changes/
- /doc/Dom0Tools/QvmRevertTemplateChanges/
- /wiki/Dom0Tools/QvmRevertTemplateChanges/

View File

@ -1,8 +1,9 @@
---
layout: doc
title: qvm-run
permalink: /doc/dom0-tools/qvm-run/
permalink: /doc/tools/3.2/dom0/qvm-run/
redirect_from:
- /doc/dom0-tools/qvm-run/
- /en/doc/dom0-tools/qvm-run/
- /doc/Dom0Tools/QvmRun/
- /wiki/Dom0Tools/QvmRun/

View File

@ -1,8 +1,9 @@
---
layout: doc
title: qvm-service
permalink: /doc/dom0-tools/qvm-service/
permalink: /doc/tools/3.2/dom0/qvm-service/
redirect_from:
- /doc/dom0-tools/qvm-service/
- /en/doc/dom0-tools/qvm-service/
- /doc/Dom0Tools/QvmService/
- /wiki/Dom0Tools/QvmService/

View File

@ -1,8 +1,9 @@
---
layout: doc
title: qvm-shutdown
permalink: /doc/dom0-tools/qvm-shutdown/
permalink: /doc/tools/3.2/dom0/qvm-shutdown/
redirect_from:
- /doc/dom0-tools/qvm-shutdown/
- /en/doc/dom0-tools/qvm-shutdown/
- /doc/Dom0Tools/QvmShutdown/
- /wiki/Dom0Tools/QvmShutdown/

View File

@ -1,8 +1,9 @@
---
layout: doc
title: qvm-start
permalink: /doc/dom0-tools/qvm-start/
permalink: /doc/tools/3.2/dom0/qvm-start/
redirect_from:
- /doc/dom0-tools/qvm-start/
- /en/doc/dom0-tools/qvm-start/
- /doc/Dom0Tools/QvmStart/
- /wiki/Dom0Tools/QvmStart/

View File

@ -1,8 +1,9 @@
---
layout: doc
title: qvm-sync-appmenus
permalink: /doc/dom0-tools/qvm-sync-appmenus/
permalink: /doc/tools/3.2/dom0/qvm-sync-appmenus/
redirect_from:
- /doc/dom0-tools/qvm-sync-appmenus/
- /en/doc/dom0-tools/qvm-sync-appmenus/
- /doc/Dom0Tools/QvmSyncAppmenus/
- /wiki/Dom0Tools/QvmSyncAppmenus/

View File

@ -1,8 +1,9 @@
---
layout: doc
title: qvm-template-commit
permalink: /doc/dom0-tools/qvm-template-commit/
permalink: /doc/tools/3.2/dom0/qvm-template-commit/
redirect_from:
- /doc/dom0-tools/qvm-template-commit/
- /en/doc/dom0-tools/qvm-template-commit/
- /doc/Dom0Tools/QvmTemplateCommit/
- /wiki/Dom0Tools/QvmTemplateCommit/

View File

@ -0,0 +1,19 @@
---
layout: doc
title: DomU Command-Line Tools for Qubes 3.2
permalink: /doc/tools/3.2/domU/
redirect_from:
- /doc/tools/3.2/domU/
- /en/doc/tools/3.2/domU/
- /doc/VmTools/
- /wiki/VmTools/
---
DomU Command-Line Tools for Qubes 3.2
=====================================
* [qvm-copy-to-vm](/doc/tools/3.2/domU/qvm-copy-to-vm/)
* [qvm-open-in-dvm](/doc/tools/3.2/domU/qvm-open-in-dvm/)
* [qvm-open-in-vm](/doc/tools/3.2/domU/qvm-open-in-vm/)
* [qvm-run](/doc/tools/3.2/domU/qvm-run/)

View File

@ -1,8 +1,9 @@
---
layout: doc
title: qvm-copy-to-vm
permalink: /doc/vm-tools/qvm-copy-to-vm/
permalink: /doc/tools/3.2/domU/qvm-copy-to-vm/
redirect_from:
- /doc/vm-tools/qvm-copy-to-vm/
- /en/doc/vm-tools/qvm-copy-to-vm/
- /doc/VmTools/QvmCopyToVm/
- /wiki/VmTools/QvmCopyToVm/

View File

@ -1,8 +1,9 @@
---
layout: doc
title: qvm-open-in-dvm
permalink: /doc/vm-tools/qvm-open-in-dvm/
permalink: /doc/tools/3.2/domU/qvm-open-in-dvm/
redirect_from:
- /doc/vm-tools/qvm-open-in-dvm/
- /en/doc/vm-tools/qvm-open-in-dvm/
- /doc/VmTools/QvmOpenInDvm/
- /wiki/VmTools/QvmOpenInDvm/

View File

@ -1,8 +1,9 @@
---
layout: doc
title: qvm-open-in-vm
permalink: /doc/vm-tools/qvm-open-in-vm/
permalink: /doc/tools/3.2/domU/qvm-open-in-vm/
redirect_from:
- /doc/vm-tools/qvm-open-in-vm/
- /en/doc/vm-tools/qvm-open-in-vm/
- /doc/VmTools/QvmOpenInVm/
- /wiki/VmTools/QvmOpenInVm/

View File

@ -1,8 +1,9 @@
---
layout: doc
title: qvm-run
permalink: /doc/vm-tools/qvm-run/
permalink: /doc/tools/3.2/domU/qvm-run/
redirect_from:
- /doc/vm-tools/qvm-run/
- /en/doc/vm-tools/qvm-run/
- /doc/VmTools/QvmRun/
- /wiki/VmTools/QvmRun/

View File

@ -0,0 +1,14 @@
---
layout: doc
title: Dom0 Command-Line Tools for Qubes 4.0
permalink: /doc/tools/4.0/dom0/
---
Dom0 Command-Line Tools for Qubes 4.0
=====================================
Reference pages for these tools are being written.
This page will be updated when they're available.
Tracking issue: <https://github.com/QubesOS/qubes-issues/issues/3538>

View File

@ -0,0 +1,14 @@
---
layout: doc
title: DomU Command-Line Tools for Qubes 4.0
permalink: /doc/tools/4.0/domU/
---
DomU Command-Line Tools for Qubes 4.0
=====================================
Reference pages for these tools are being written.
This page will be updated when they're available.
Tracking issue: <https://github.com/QubesOS/qubes-issues/issues/3538>

View File

@ -0,0 +1,13 @@
---
layout: doc
title: Qubes 3.2 Command-Line Tools
permalink: /doc/tools/3.2/
---
Qubes 3.2 Command-Line Tools
============================
Please see the page for your desired domain:
* [Dom0 Command-Line Tools](/doc/tools/3.2/dom0/)
* [DomU Command-Line Tools](/doc/tools/3.2/domU/)

View File

@ -0,0 +1,13 @@
---
layout: doc
title: Qubes 4.0 Command-Line Tools
permalink: /doc/tools/4.0/
---
Qubes 4.0 Command-Line Tools
============================
Please see the page for your desired domain:
* [Dom0 Command-Line Tools](/doc/tools/4.0/dom0/)
* [DomU Command-Line Tools](/doc/tools/4.0/domU/)

View File

@ -1,17 +0,0 @@
---
layout: doc
title: VM Tools
permalink: /doc/vm-tools/
redirect_from:
- /en/doc/vm-tools/
- /doc/VmTools/
- /wiki/VmTools/
---
VM tools:
- [qvm-copy-to-vm](/doc/vm-tools/qvm-copy-to-vm/)
- [qvm-open-in-dvm](/doc/vm-tools/qvm-open-in-dvm/)
- [qvm-open-in-vm](/doc/vm-tools/qvm-open-in-vm/)
- [qvm-run](/doc/vm-tools/qvm-run/)