Bug#792518: Manual page for the docker-compose executable is missing
Hi there, shouldn't this bug be marked as resolved? Regards David signature.asc Description: OpenPGP digital signature
Bug#792518: Manual page for the docker-compose executable is missing
forwarded 792518 https://github.com/docker/compose/issues/1727 thanks Awesome job! Thanks Dariusz! I just opened an upstream bug report in order to get it included upstream. Regards, -- Carl Chenet Blog : https://carlchenet.com https://identi.ca/carlchenet | https://twitter.com/carl_chenet FOSS contributions : https://www.ohloh.net/accounts/chaica -- To UNSUBSCRIBE, email to debian-bugs-dist-requ...@lists.debian.org with a subject of unsubscribe. Trouble? Contact listmas...@lists.debian.org
Bug#792518: Manual page for the docker-compose executable is missing
On 15.07.15 16:26:26, Carl Chenet wrote: Package: docker-compose Version: 1.3.1-1 Severity: serious The manual page for the docker-compose executable is missing. [...] Dear Maintainer, I submit a manpage for docker-compose. It covers all of the commands, as well as environmental variables. -- Dariusz Dwornikowski, Institute of Computing Science, Poznań University of Technology www.cs.put.poznan.pl/ddwornikowski/ room 1.6.2 BTiCW | tel. +48 61 665 23 71 .TH DOCKER-COMPOSE 1 July 2015 docker-compose User Commands .SH NAME docker-compose \- Define and run multi\-container applications with Docker. .SH SYNOPSIS .B docker\-compose [\fIOPTIONS\fR] [\fICOMMAND\fR] [\fIARGS\fR]... .SH DESCRIPTION .PP docker-compose allows you to define a multi-container application with all of its dependencies in a single file, then spin the application up in a single command. The application’s structure and configuration are held in a single place, which makes spinning up applications simple and repeatable everywhere. .SH OPTIONS .TP \fB\-f\fR, \fB\-\-file\fR FILE Specify an alternate compose file (default: docker\-compose.yml) .TP \fB\-p\fR, \fB\-\-project\-name\fR NAME Specify an alternate project name (default: directory name) .TP \fB\-\-verbose\fR Show more output .TP \fB\-v\fR, \fB\-\-version\fR Print version and exit .SH COMMANDS .SS build Build or rebuild services .TP \fB\-\-no\-cache\fR Do not use cache when building the image. .SS help Displays help and usage information on a command. .SS kill Forces running containers to stop by sending a SIGKILL signal. .TP \fB\-s\fR SIGNAL SIGNAL to send to the container. Default signal is SIGKILL. .SS logs View output from containers. .TP \fB\-\-no\-color\fR Produce a monochrome output. .SS port Print the public port for a port binding .TP \fB\-\-protocol=proto\fR Choose the 4th layer protocol, tcp or udp. Default is tcp. .TP \fB\-\-index=index\fR Index of the container if there are multiple instances of a service. Default is 1. .SS ps List containers. .TP \fB\-q\fR Only display IDs. .SS pull Pulls service images from Docker registry. .TP \fB\-\-allow\-insecure\-ssl\fR Allow insecure connections to the Docker registry. .SS restart Restart running containers. .TP \fB\-t\fR, \fB\-\-timeout\fR \fITIMEOUT\fR Specify a shutdown timeout in seconds. Default is 10. .SS rm Remove stopped service containers .TP \fB\-f\fR, \fB\-\-force\fR Do not ask to confirm removal. .TP \fB\-v\fR Remove volumes associated with containers. .SS run Run a one\-off command on a service. By default linked services will be started, unless they are already running. .TP \fB\-\-allow\-insecure\-ssl\fR Allow insecure connections to the Docker registry. .TP \fB\-d\fR Detached mode. Run container in the background, print new container name. .TP \fB\-\-entrypoint\fR \fICMD\fR Override the entrypoint of the image with \fICMD\fR. .TP \fB\-e\fR KEY=VAL Set an environment variable. Can be used multiple times. .TP \fB\-u\fR, \fB\-\-user=\fR\fIUSER\fR Run as a specific \fIUSER\fR, a username or uid. .TP \fB\-\-no\-deps\fR Do not start linked services. .TP \fB\-\-rm\fR Remove container after run. This option is ignored in the detached mode. .TP \fB\-\-service\-ports\fR Run command with the service's ports enabled and mapped to the host. .TP \fB\-T\fR Disable pseudo tty allocation. By default a tty is allocated. .SS scale Set number of containers to run for a service. Numbers are specified in the form \fBservice=num\fR as arguments. .PP .RS .nf # docker\-compose scale web=2 worker=3 .SS start Start existing containers. .SS stop Stop running containers without removing them. .TP \fB\-t\fR, \fB\-\-timeout\fR \fITIMEOUT\fR Specify a shutdown timeout in seconds. Default is 10. .SS up Build, (re)create, start and attach to containers. If there are existing containers for a service, `docker-compose up` will stop and recreate them (preserving mounted volumes with volumes-from), so that changes in `docker-compose.yml` are picked up. If you do not want existing containers to be recreated, `docker-compose up --no-recreate` will re-use existing containers. .TP \fB\-\-allow\-insecure\-ssl\fR Allow insecure connections to the Docker registry. .TP \fB\-d\fR Detached mode. Run container in the background, print new container name. .TP \fB\-\-no\-color\fR Produce a monochrome output. .TP \fB\-\-no\-deps\fR Do not start linked services. .TP \fB\-\-x\-smart\-recreate\fR Only recreate containers whose configuration or image needs to be updated. This feature is experimental. .TP \fB\-\-no\-recreate\fR If containers already exist, do not recreate them. .TP \fB\-\-no\-build\fR Do not build an image even if it is missing. .TP \fB\-t\fR, \fB\-\-timeout\fR \fITIMEOUT\fR Specify a shutdown timeout in seconds. Default is 10. .SS migrate\-to\-labels Recreate containers to add labels. If docker-compose detects containers that were created without labels, it will refuse to run so that you don't end up
Bug#792518: Manual page for the docker-compose executable is missing
Control: tags -1 pending Hi Dariusz, On 19 July 2015 at 04:32, Dariusz Dwornikowski dariusz.dwornikow...@cs.put.poznan.pl wrote: On 15.07.15 16:26:26, Carl Chenet wrote: Package: docker-compose Version: 1.3.1-1 Severity: serious The manual page for the docker-compose executable is missing. [...] Dear Maintainer, I submit a manpage for docker-compose. It covers all of the commands, as well as environmental variables. Thank you. Applied this locally, will be part of the next upload. -- Saludos, Felipe Sateler -- To UNSUBSCRIBE, email to debian-bugs-dist-requ...@lists.debian.org with a subject of unsubscribe. Trouble? Contact listmas...@lists.debian.org
Bug#792518: Manual page for the docker-compose executable is missing
Control: severity -1 wishlist Control: tags -1 newcomer upstream On 15 July 2015 at 11:26, Carl Chenet cha...@debian.org wrote: Package: docker-compose Version: 1.3.1-1 Severity: serious The manual page for the docker-compose executable is missing. Upstream unfortunately does not have a man page. I welcome patches converting the current cli.md to a man page, but I will not spend time on this. -- Saludos, Felipe Sateler -- To UNSUBSCRIBE, email to debian-bugs-dist-requ...@lists.debian.org with a subject of unsubscribe. Trouble? Contact listmas...@lists.debian.org
Bug#792518: Manual page for the docker-compose executable is missing
On 15/07/15 19:21, Felipe Sateler wrote: Control: severity -1 wishlist Control: tags -1 newcomer upstream On 15 July 2015 at 11:26, Carl Chenet cha...@debian.org wrote: Package: docker-compose Version: 1.3.1-1 Severity: serious The manual page for the docker-compose executable is missing. Upstream unfortunately does not have a man page. I welcome patches converting the current cli.md to a man page, but I will not spend time on this. You should care, it's not pedantic, it's not a wishlist (a manual page is not a feature request or really difficult to implement [1]), it's a bug per Debian Policy Manual and should be reported to the upstream. If no manual page is available, this is considered as a bug and should be reported to the Debian Bug Tracking System (the maintainer of the package is allowed to write this bug report themselves, if they so desire). Do not close the bug report until a proper man page is available.[110] [2] Here is a page with information about the manual pages [3]. [1] : https://www.debian.org/Bugs/Developer [2] : https://www.debian.org/doc/debian-policy/ch-docs.html [3] : https://qa.debian.org/man-pages.html Regards, -- Carl Chenet Blog : https://carlchenet.com https://identi.ca/carlchenet | https://twitter.com/carl_chenet FOSS contributions : https://www.ohloh.net/accounts/chaica -- To UNSUBSCRIBE, email to debian-bugs-dist-requ...@lists.debian.org with a subject of unsubscribe. Trouble? Contact listmas...@lists.debian.org
Bug#792518: Manual page for the docker-compose executable is missing
Package: docker-compose Version: 1.3.1-1 Severity: serious The manual page for the docker-compose executable is missing. $ man docker-compose No manual entry for docker-compose See 'man 7 undocumented' for help when manual pages are not available. $ docker-compose -h Define and run multi-container applications with Docker. Usage: docker-compose [options] [COMMAND] [ARGS...] docker-compose -h|--help Options: -f, --file FILE Specify an alternate compose file (default: docker-compose.yml) -p, --project-name NAME Specify an alternate project name (default: directory name) --verbose Show more output -v, --version Print version and exit Commands: build Build or rebuild services help Get help on a command kill Kill containers logs View output from containers port Print the public port for a port binding ps List containers pull Pulls service images restartRestart services rm Remove stopped containers runRun a one-off command scale Set number of containers for a service start Start services stop Stop services up Create and start containers migrate-to-labels Recreate containers to add labels Regards, Carl Chenet -- System Information: Debian Release: 8.0 APT prefers stable-updates APT policy: (500, 'stable-updates'), (500, 'testing'), (500, 'stable') Architecture: amd64 (x86_64) Foreign Architectures: i386 Kernel: Linux 3.18.0-trunk-amd64 (SMP w/4 CPU cores) Locale: LANG=fr_FR.UTF-8, LC_CTYPE=fr_FR.UTF-8 (charmap=UTF-8) Shell: /bin/sh linked to /bin/dash Init: systemd (via /run/systemd/system) Versions of packages docker-compose depends on: ii python2.7.8-2 ii python-docker 1.2.3-1 ii python-dockerpty 0.3.4-1 ii python-docopt 0.6.2-1 ii python-requests 2.7.0-3 ii python-six1.8.0-1 ii python-texttable 0.8.1-1 ii python-websocket 0.18.0-2 ii python-yaml 3.11-2 pn python:anynone Versions of packages docker-compose recommends: ii docker.io 1.6.2~dfsg1-1 docker-compose suggests no packages. -- no debconf information -- To UNSUBSCRIBE, email to debian-bugs-dist-requ...@lists.debian.org with a subject of unsubscribe. Trouble? Contact listmas...@lists.debian.org
Bug#792518: Manual page for the docker-compose executable is missing
Control: severity -1 minor On 15 Jul 2015 14:43, Carl Chenet cha...@debian.org wrote: On 15/07/15 19:21, Felipe Sateler wrote: Control: severity -1 wishlist Control: tags -1 newcomer upstream On 15 July 2015 at 11:26, Carl Chenet cha...@debian.org wrote: Package: docker-compose Version: 1.3.1-1 Severity: serious The manual page for the docker-compose executable is missing. Upstream unfortunately does not have a man page. I welcome patches converting the current cli.md to a man page, but I will not spend time on this. You should care, it's not pedantic, it's not a wishlist Fine, minor it is then. It certainly isn't serious. (a manual page is not a feature request or really difficult to implement [1]), it's a bug per Debian Policy Manual and should be reported to the upstream. If no manual page is available, this is considered as a bug and should be reported to the Debian Bug Tracking System (the maintainer of the package is allowed to write this bug report themselves, if they so desire). Do not close the bug report until a proper man page is available.[110] [2] Here is a page with information about the manual pages [3]. I'm sorry I don't share your enthusiasm for man pages. Since my debian time is fairly limited, I will not spend it on issues I do not find of importance. Of course, I will not block others that wish to add manpages to docker-compose. Saludos, -- To UNSUBSCRIBE, email to debian-bugs-dist-requ...@lists.debian.org with a subject of unsubscribe. Trouble? Contact listmas...@lists.debian.org
