ZRYTHM(1)

๐Ÿ“ฆ version 1.0.0, in nixos 26.05, nixpkgs unstable

๐Ÿ’… ZRYTHM(1) โ€” the manual page, bestie edition ๐Ÿ’…

okay so this is the ZRYTHM(1) page from the User Commands section of the manual, and we're gonna get you fluent in it. pull up a chair ๐ŸŽ€


โœจ NAME โœจ

Zrythm โ€” literally just Zrythm. that's the name. iconic, no notes ๐Ÿ‘‘


๐ŸŒธ DESCRIPTION ๐ŸŒธ

Zrythm is a digital audio workstation, and it was designed to be featureful and easy to use. like, both at once, which is honestly a flex. it's giving "I have unlimited automation options, LV2 plugin support, JACK support and chord assistance" and it is NOT being shy about it ๐Ÿ’–

๐ŸŽ€ Usage:

zrythm [OPTION???] [PROJECT-FILE]

Run Zrythm, optionally passing a project file. that's it, that's the whole vibe. (yes, the [OPTION???] has three question marks in it, that's canon, don't come for me ๐Ÿ˜ญ)


๐Ÿฆ‹ Help Options ๐Ÿฆ‹

these are the "wait, what does this do again?" girlies ๐Ÿซถ

  • -h, --help โ€” Show help options. your first stop, always.
  • --help-all โ€” Show all help options. all of them. the full lore drop.
  • --help-gapplication โ€” Show GApplication options. (GApplication has its own options, and this is how you meet them.)

๐Ÿ’… Application Options ๐Ÿ’…

the main character section, honestly. every flag, no skips ๐Ÿ”ฅ

  • -v, --version โ€” Print version information. know what you're running, bestie.
  • --pretty โ€” Print output in user-friendly way. for when you want your terminal to be cute and readable instead of a wall of text.
  • -p, --print-settings โ€” Print current settings. a little peek at how you've got things configured.
  • --reset-to-factory โ€” Reset to factory settings. nuking your customized setup back to defaults โ€” dramatic, but sometimes necessary ๐Ÿ’€
  • --audio-backend=BACKEND โ€” Override the audio backend to use.
  • --midi-backend=BACKEND โ€” Override the MIDI backend to use.
  • --dummy โ€” Shorthand for --midi-backend=none --audio-backend=none. no audio, no MIDI, just vibes (and testing, presumably).
  • --buf-size=BUF_SIZE โ€” Override the buffer size to use for the audio backend, if applicable. note the if applicable โ€” not every backend cares.
  • --samplerate=SAMPLERATE โ€” Override the samplerate to use for the audio backend, if applicable. again, if applicable.
  • -o, --output=FILE โ€” File or directory to output to.
  • --cyaml-log-level=LOG-LEVEL โ€” Cyaml log level. yes that's a log level, for cyaml, and that's all it says โœจ

๐ŸŒˆ ENVIRONMENT ๐ŸŒˆ

the settings you set outside the app, iykyk ๐Ÿงš

  • LV2_PATH โ€” Specify custom path for scanning LV2 plugins.
  • ZRYTHM_DSP_THREADS โ€” Number of threads to use for DSP, including the main one. (including the main one โ€” don't forget that part!)
  • ZRYTHM_SKIP_PLUGIN_SCAN โ€” Disable plugin scanning.
  • ZRYTHM_DEBUG โ€” Show additional debug info about objects. detective mode ๐Ÿ”

๐Ÿ“ FILES ๐Ÿ“

the page lists these four entries, each with the ยฎ marker in front, fr fr as written:

  • ยฎLog files for each Zrythm run
  • ยฎProject templates
  • ยฎUser themes
  • ยฎCached VST plugin descriptors

โญ EXAMPLES โญ

  • -p --pretty โ€” Pretty-print current settings.
and pls, if something breaks: Please report issues to https://gitlab.zrythm.org/zrythm/zrythm/-/issues โ€” they wanna hear about it ๐Ÿซถ

๐Ÿ‘‘ AUTHOR ๐Ÿ‘‘

Alexandros Theodotou ๐Ÿ’œ


Copyright (C) 2018-2024 The Zrythm contributors This is free software; see the source for copying conditions. There is NO warranty; not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.

(that's a big NO on the warranty, capital letters and all โ€” read it and weep ๐Ÿ˜ญ)


okay that's the whole page, you're officially fluent ๐Ÿ’– this was Zrythm 1.0.0, dated January 1980 (yes, 1980, iconic timestamp energy ๐Ÿ•ฐ๏ธ), and you're all caught up. go make some music, bestie ๐ŸŽงโœจ

๐Ÿ“ฆ where this page comes from