{ "content": [ { "type": "text", "text": "# debconf-apt-progress (man)\n\n## NAME\n\ndebconf-apt-progress - install packages using debconf to display a progress bar\n\n## SYNOPSIS\n\ndebconf-apt-progress [--] command [args ...]\ndebconf-apt-progress --config\ndebconf-apt-progress --start\ndebconf-apt-progress --from waypoint --to waypoint [--] command [args ...]\ndebconf-apt-progress --stop\n\n## DESCRIPTION\n\ndebconf-apt-progress installs packages using debconf to display a progress bar. The given\ncommand should be any command-line apt frontend; specifically, it must send progress\ninformation to the file descriptor selected by the \"APT::Status-Fd\" configuration option, and\nmust keep the file descriptors nominated by the \"APT::Keep-Fds\" configuration option open\nwhen invoking debconf (directly or indirectly), as those file descriptors will be used for\nthe debconf passthrough protocol.\n\n## Sections\n\n- **NAME**\n- **SYNOPSIS**\n- **DESCRIPTION**\n- **OPTIONS** (5 subsections)\n- **EXAMPLES**\n- **RETURN CODE**\n- **AUTHORS**\n\nUse structuredContent.sections for detailed options, examples, and full documentation.\n" } ], "structuredContent": { "command": "debconf-apt-progress", "section": "", "mode": "man", "summary": "debconf-apt-progress - install packages using debconf to display a progress bar", "synopsis": "debconf-apt-progress [--] command [args ...]\ndebconf-apt-progress --config\ndebconf-apt-progress --start\ndebconf-apt-progress --from waypoint --to waypoint [--] command [args ...]\ndebconf-apt-progress --stop", "tldr_summary": null, "tldr_examples": [], "tldr_source": null, "flags": [ { "flag": "", "long": "--config", "arg": null, "description": "Print environment variables necessary to start up a progress bar frontend." }, { "flag": "", "long": "--start", "arg": null, "description": "Start up a progress bar, running from 0 to 100 by default. Use --from and --to to use other endpoints. --from waypoint If used with --start, make the progress bar begin at waypoint rather than 0. Otherwise, install packages with their progress bar beginning at this \"waypoint\". Must be used with --to. --to waypoint If used with --start, make the progress bar end at waypoint rather than 100. Otherwise, install packages with their progress bar ending at this \"waypoint\". Must be used with --from." }, { "flag": "", "long": "--stop", "arg": null, "description": "Stop a running progress bar." }, { "flag": "", "long": "--no-progress", "arg": null, "description": "Avoid starting, stopping, or stepping the progress bar. Progress messages from apt, media change events, and debconf questions will still be passed through to debconf. --dlwaypoint percentage Specify what percent of the progress bar to use for downloading packages. The remainder will be used for installing packages. The default is to use 15% for downloading and the remaining 85% for installing. --logfile file Send the normal output from apt to the given file." }, { "flag": "", "long": "--logstderr", "arg": null, "description": "Send the normal output from apt to stderr. If you supply neither --logfile nor --logstderr, the normal output from apt will be discarded. -- Terminate options. Since you will normally need to give at least the -y argument to the command being run, you will usually need to use -- to prevent that being interpreted as an option to debconf-apt-progress itself." } ], "examples": [ "Install the GNOME desktop and an X window system development environment within a progress", "bar:", "debconf-apt-progress -- aptitude -y install gnome x-window-system-dev", "Install the GNOME, KDE, and XFCE desktops within a single progress bar, allocating 45% of the", "progress bar for each of GNOME and KDE and the remaining 10% for XFCE:", "#! /bin/sh", "set -e", "case $1 in", "'')", "eval \"$(debconf-apt-progress --config)\"", "\"$0\" debconf", ";;", "debconf)", ". /usr/share/debconf/confmodule", "debconf-apt-progress --start", "debconf-apt-progress --from 0 --to 45 -- apt-get -y install gnome", "debconf-apt-progress --from 45 --to 90 -- apt-get -y install kde", "debconf-apt-progress --from 90 --to 100 -- apt-get -y install xfce4", "debconf-apt-progress --stop", ";;", "esac" ], "see_also": [], "section_outline": [ { "name": "NAME", "lines": 2, "subsections": [] }, { "name": "SYNOPSIS", "lines": 6, "subsections": [] }, { "name": "DESCRIPTION", "lines": 22, "subsections": [] }, { "name": "OPTIONS", "lines": 1, "subsections": [ { "name": "--config", "lines": 2, "long": "--config" }, { "name": "--start", "lines": 15, "long": "--start" }, { "name": "--stop", "lines": 2, "long": "--stop" }, { "name": "--no-progress", "lines": 11, "long": "--no-progress" }, { "name": "--logstderr", "lines": 7, "long": "--logstderr" } ] }, { "name": "EXAMPLES", "lines": 25, "subsections": [] }, { "name": "RETURN CODE", "lines": 4, "subsections": [] }, { "name": "AUTHORS", "lines": 7, "subsections": [] } ], "sections": { "NAME": { "content": "debconf-apt-progress - install packages using debconf to display a progress bar\n", "subsections": [] }, "SYNOPSIS": { "content": "debconf-apt-progress [--] command [args ...]\ndebconf-apt-progress --config\ndebconf-apt-progress --start\ndebconf-apt-progress --from waypoint --to waypoint [--] command [args ...]\ndebconf-apt-progress --stop\n", "subsections": [] }, "DESCRIPTION": { "content": "debconf-apt-progress installs packages using debconf to display a progress bar. The given\ncommand should be any command-line apt frontend; specifically, it must send progress\ninformation to the file descriptor selected by the \"APT::Status-Fd\" configuration option, and\nmust keep the file descriptors nominated by the \"APT::Keep-Fds\" configuration option open\nwhen invoking debconf (directly or indirectly), as those file descriptors will be used for\nthe debconf passthrough protocol.\n\nThe arguments to the command you supply should generally include -y (for apt-get or aptitude)\nor similar to avoid the apt frontend prompting for input. debconf-apt-progress cannot do this\nitself because the appropriate argument may differ between apt frontends.\n\nThe --start, --stop, --from, and --to options may be used to create a progress bar with\nmultiple segments for different stages of installation, provided that the caller is a debconf\nconfmodule. The caller may also interact with the progress bar itself using the debconf\nprotocol if it so desires.\n\ndebconf locks its config database when it starts up, which makes it unfortunately\ninconvenient to have one instance of debconf displaying the progress bar and another passing\nthrough questions from packages being installed. If you're using a multiple-segment progress\nbar, you'll need to eval the output of the --config option before starting the debconf\nfrontend to work around this. See \"EXAMPLES\" in the EXAMPLES section below.\n", "subsections": [] }, "OPTIONS": { "content": "", "subsections": [ { "name": "--config", "content": "Print environment variables necessary to start up a progress bar frontend.\n", "long": "--config" }, { "name": "--start", "content": "Start up a progress bar, running from 0 to 100 by default. Use --from and --to to use\nother endpoints.\n\n--from waypoint\nIf used with --start, make the progress bar begin at waypoint rather than 0.\n\nOtherwise, install packages with their progress bar beginning at this \"waypoint\". Must be\nused with --to.\n\n--to waypoint\nIf used with --start, make the progress bar end at waypoint rather than 100.\n\nOtherwise, install packages with their progress bar ending at this \"waypoint\". Must be\nused with --from.\n", "long": "--start" }, { "name": "--stop", "content": "Stop a running progress bar.\n", "long": "--stop" }, { "name": "--no-progress", "content": "Avoid starting, stopping, or stepping the progress bar. Progress messages from apt, media\nchange events, and debconf questions will still be passed through to debconf.\n\n--dlwaypoint percentage\nSpecify what percent of the progress bar to use for downloading packages. The remainder\nwill be used for installing packages. The default is to use 15% for downloading and the\nremaining 85% for installing.\n\n--logfile file\nSend the normal output from apt to the given file.\n", "long": "--no-progress" }, { "name": "--logstderr", "content": "Send the normal output from apt to stderr. If you supply neither --logfile nor\n--logstderr, the normal output from apt will be discarded.\n\n-- Terminate options. Since you will normally need to give at least the -y argument to the\ncommand being run, you will usually need to use -- to prevent that being interpreted as\nan option to debconf-apt-progress itself.\n", "long": "--logstderr" } ] }, "EXAMPLES": { "content": "Install the GNOME desktop and an X window system development environment within a progress\nbar:\n\ndebconf-apt-progress -- aptitude -y install gnome x-window-system-dev\n\nInstall the GNOME, KDE, and XFCE desktops within a single progress bar, allocating 45% of the\nprogress bar for each of GNOME and KDE and the remaining 10% for XFCE:\n\n#! /bin/sh\nset -e\ncase $1 in\n'')\neval \"$(debconf-apt-progress --config)\"\n\"$0\" debconf\n;;\ndebconf)\n. /usr/share/debconf/confmodule\ndebconf-apt-progress --start\ndebconf-apt-progress --from 0 --to 45 -- apt-get -y install gnome\ndebconf-apt-progress --from 45 --to 90 -- apt-get -y install kde\ndebconf-apt-progress --from 90 --to 100 -- apt-get -y install xfce4\ndebconf-apt-progress --stop\n;;\nesac\n", "subsections": [] }, "RETURN CODE": { "content": "The exit code of the specified command is returned, unless the user hit the cancel button on\nthe progress bar. If the cancel button was hit, a value of 30 is returned. To avoid\nambiguity, if the command returned 30, a value of 3 will be returned.\n", "subsections": [] }, "AUTHORS": { "content": "Colin Watson \n\nJoey Hess \n\n\n\n2022-02-20 DEBCONF-APT-PROGRESS(1)", "subsections": [] } } } }