Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Document expected QEMU display types (fixes #323) #325

Merged
merged 3 commits into from
Sep 23, 2024
Merged

Document expected QEMU display types (fixes #323) #325

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
4f47560
Document expected display types for QEMU
hartwork Sep 23, 2024
424b45b
README.md: Get --help output back in sync
hartwork Sep 23, 2024
743f843
README.md: Make --help output generation more obvious
hartwork Sep 23, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 7 additions & 5 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ To install from a Git clone _for development_:

Please make sure to install these _non-PyPI dependencies_ as well:
- `grub-mkrescue` of [GRUB 2](https://www.gnu.org/software/grub/) (package `grub-common` on Debian and Ubuntu)
- [QEMU](https://wiki.qemu.org/Main_Page) — _hypervisor that performs hardware virtualization_
- [QEMU](https://wiki.qemu.org/Main_Page) (with GTK or SDL display support) — _hypervisor that performs hardware virtualization_
- [OVMF](https://github.com/tianocore/tianocore.github.io/wiki/OVMF) — EFI bios image for use with QEMU
- [mtools](https://www.gnu.org/software/mtools/) — _collection of utilities to access MS-DOS_
- `xorriso` of [libisoburn](https://dev.lovelyhq.com/libburnia/libisoburn) — _frontend which enables creation and expansion of the ISO format_
Expand All @@ -42,20 +42,21 @@ Please make sure to install these _non-PyPI dependencies_ as well:
## Usage

```console
# grub2-theme-preview --help
# COLUMNS=80 grub2-theme-preview --help
usage: grub2-theme-preview [-h] [--grub-cfg PATH] [--verbose]
[--resolution WxH] [--timeout SECONDS]
[--add TARGET=/SOURCE] [--version]
[--grub2-mkrescue COMMAND] [--qemu COMMAND]
[--xorriso COMMAND] [--no-kvm] [--debug]
[--xorriso COMMAND] [--display DISPLAY]
[--full-screen] [--no-kvm] [--vga CARD] [--debug]
[--plain-rescue-image]
PATH

positional arguments:
PATH path of theme directory (or PNG/TGA image file) to
preview

optional arguments:
options:
-h, --help show this help message and exit
--grub-cfg PATH path of custom grub.cfg file to use (default:
/boot/grub{2,}/grub.cfg)
Expand All @@ -76,7 +77,8 @@ command location arguments:

arguments related to invokation of QEMU/KVM:
--display DISPLAY pass "-display DISPLAY" to QEMU, see "man qemu" for
details (default: use QEMU's default display)
details (default: use QEMU's default display,
hopefully either GTK or SDL)
--full-screen pass "-full-screen" to QEMU
--no-kvm do not pass -enable-kvm to QEMU (and hence fall back
to acceleration "tcg" which is significantly slower
Expand Down
2 changes: 1 addition & 1 deletion grub2_theme_preview/__main__.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -299,7 +299,7 @@ def parse_command_line(argv):
dest='qemu_display',
metavar='DISPLAY',
help='pass "-display DISPLAY" to QEMU, see "man qemu" for details'
' (default: use QEMU\'s default display)')
' (default: use QEMU\'s default display, hopefully either GTK or SDL)')

qemu.add_argument('--full-screen',
dest='qemu_full_screen',
Expand Down