Command line
Generated from the help of manfred 1.0.1. manfred help <command> prints the same in a terminal.
A line Manfred cannot parse gets clap’s short error on stderr and exits 2; a recipe, camera or file it refuses after that is one line on stderr, manfred <command>: …, and exits 1.
manfred
Section titled “manfred”Scenes as recipes: GLB headless, a live window and path-traced stills
Usage: manfred <COMMAND>
Commands: build Build a recipe into its GLB, its sidecar and its bake recipe check Validate a recipe and list its problems diff Compare two GLBs by structure, or draw both alike and compare them by PSNR shot One still on the live renderer, headless render A still path-traced on the engine's tracer clip A camera moving along the recipe's path, as frames and a video gui The window, or one frame of it offscreen with --shot help Print this message or the help of the given subcommand(s)
Options: -h, --help Print help -V, --version Print versionmanfred build
Section titled “manfred build”Build a recipe into its GLB, its sidecar and its bake recipe
Usage: manfred build [OPTIONS] <recipe>
Arguments: <recipe> The recipe to build
Options: --variant <name> Build this variant instead of the recipe --all-variants Build the recipe and then every variant --set <key=value> Replace a value the recipe has; repeatable --out <dir> Write every file into this folder instead of the recipe's [output] paths -h, --help Print helpmanfred check
Section titled “manfred check”Validate a recipe and list its problems
Usage: manfred check <recipe>
Arguments: <recipe> The recipe to check
Options: -h, --help Print helpmanfred diff
Section titled “manfred diff”Compare two GLBs by structure, or draw both alike and compare them by PSNR
Usage: manfred diff [OPTIONS] <a.glb> <b.glb>
Arguments: <a.glb> The first GLB <b.glb> The second GLB
Options: --json Print the report as JSON --render Also draw both alike through a recipe and compare the pictures by PSNR --recipe <recipe> The recipe whose cameras, lights and look draw both --camera <name> The camera to draw through [default: the recipe's first] --size <WxH> The pictures' size [default: the recipe's plate, or 1586x992] --floor <dB> The least PSNR that passes [default: 35] -h, --help Print helpmanfred shot
Section titled “manfred shot”One still on the live renderer, headless
Usage: manfred shot [OPTIONS] --camera <name> --size <WxH> --out <png> <recipe>
Arguments: <recipe> The recipe to draw
Options: --camera <name> The recipe's camera to look through --size <WxH> The still's size in pixels --out <png> The PNG to write --variant <name> Draw this variant instead of the recipe --set <key=value> Replace a value the recipe has; repeatable -h, --help Print helpmanfred render
Section titled “manfred render”A still path-traced on the engine's tracer
Usage: manfred render [OPTIONS] --camera <name> --out <file> <recipe>
Arguments: <recipe> The recipe to render
Options: --camera <name> The recipe's camera to look through --spp <N> Samples per pixel, the most any pixel takes [default: the recipe's trace.spp, else 64] --threshold <T> A pixel stops once its noise is under this; 0 runs every pixel to --spp [default: the recipe's trace.threshold, else 0.01] --min-samples <N> Samples every pixel takes before it may stop [default: the recipe's trace.min_samples, else 16] --draft A quick look: 12 spp at most, threshold 0.05, 6 samples first --seed <S> The tracer's seed [default: the recipe's seed, cut to 32 bits] --size <WxH> The picture's size [default: 1586x992, or 2048x1024 with --equirect] --equirect The full sphere around the camera --ortho An orthographic view of the camera's ortho_height --crop <x,y,w,h> Render only this rectangle of the frame, the same pixels as the full frame's --variant <name> Render this variant instead of the recipe --set <key=value> Replace a value the recipe has, after the variant; repeatable --denoise <off|on> Denoise the trace [default: on for a .png or master, off for .exr and .hdr] --out <file> The picture to write: .png (8-bit, dithered), .exr or .hdr --master <file> Also write a 16-bit .png master through the recipe's finish --progress <plain|json> Progress on stderr: plain lines, or JSON lines with the fraction and an ETA [default: plain] -h, --help Print helpmanfred clip
Section titled “manfred clip”A camera moving along the recipe's path, as frames and a video
Usage: manfred clip [OPTIONS] --camera <name> --frames <N> --fps <F> --size <WxH> --out <dir> <recipe>
Arguments: <recipe> The recipe to film
Options: --camera <name> The recipe's camera, with a path to move along --frames <N> How many frames --fps <F> Frames per second, from 1 to 240 --size <WxH> Each frame's size in pixels --out <dir> The folder for the frames; a second run resumes it --trace Path-trace each frame instead of drawing it live --spp <N> The tracer's samples per pixel [default: 64] --variant <name> Film this variant instead of the recipe --set <key=value> Replace a value the recipe has; repeatable --video <file> Encode the frames into this .mp4 or .webm with pconv -h, --help Print helpmanfred gui
Section titled “manfred gui”The window, or one frame of it offscreen with --shot
Usage: manfred gui [OPTIONS] [recipe|folder]
Arguments: [recipe|folder] A recipe, a .scene.toml, or a folder to pick one from [default: the start scene]
Options: --shot <png> Draw one frame offscreen into this PNG --clip <dir> Film the window playing a tape: an x264 master, its poster and a manifest in this folder --tape <file> The tape a clip plays: the script's steps, one a line, and wait <seconds> --fps <F> A clip's frames per second [default: 30] [possible values: 30, 60, 120] --poster <when> A clip's poster: first, last, or the frame at a time in seconds [default: first] --size <WxH> The frame's size [default: 1586x992, or the fixture's] --input <script> Play a script of keys and clicks, one step a line, before the frame --fake Read the recipe without building it --fixture <name> Draw one widget of the editor style [possible values: header, tabs, keycap, pill, dotted, number] --start Draw the start scene -h, --help Print help