github
/
k3s
mirror of https://github.com/k3s-io/k3s
1
0
Fork 0
Code Issues Projects Releases Wiki Activity
k3s/docs/man/man1/kubectl-log.1

49 lines
914 B
Groff
Raw Normal View History

automatically generate man pages for kubectl generate man pages for kubectl using the cobra.Command information. This will directly create files in (by default) docs/man/man1/ called kubectl*.1. Each child verb/cobra command will gets its own man page.
2015-02-06 03:02:44 +00:00
.TH "KUBERNETES" "1" " kubernetes User Manuals" "Eric Paris" "Jan 2015" ""
.SH NAME
.PP
kubectl log \- Print the logs for a container in a pod.
.SH SYNOPSIS
.PP
\fBkubectl log\fP [OPTIONS]
.SH DESCRIPTION
.PP
Print the logs for a container in a pod. If the pod has only one container, the container name is optional.
.PP
Examples:
.PP
.RS
.nf
// Returns snapshot of ruby\-container logs from pod 123456\-7890.
Merge branch 'kubectl-man' of https://github.com/eparis/kubernetes into eparis-kubectl-man Conflicts: docs/kubectl.md COMMIT_BLOCKED_ON_GENDOCS
2015-02-19 19:51:38 +00:00
$ kubectl log 123456\-7890 ruby\-container
automatically generate man pages for kubectl generate man pages for kubectl using the cobra.Command information. This will directly create files in (by default) docs/man/man1/ called kubectl*.1. Each child verb/cobra command will gets its own man page.
2015-02-06 03:02:44 +00:00
// Starts streaming of ruby\-container logs from pod 123456\-7890.
Merge branch 'kubectl-man' of https://github.com/eparis/kubernetes into eparis-kubectl-man Conflicts: docs/kubectl.md COMMIT_BLOCKED_ON_GENDOCS
2015-02-19 19:51:38 +00:00
$ kubectl log \-f 123456\-7890 ruby\-container
automatically generate man pages for kubectl generate man pages for kubectl using the cobra.Command information. This will directly create files in (by default) docs/man/man1/ called kubectl*.1. Each child verb/cobra command will gets its own man page.
2015-02-06 03:02:44 +00:00
.fi
.RE
.SH OPTIONS
.PP
\fB\-f\fP, \fB\-\-follow\fP=false
Specify if the logs should be streamed.
.SH SEE ALSO
.PP
\fBkubectl(1)\fP,
.SH HISTORY
.PP
January 2015, Originally compiled by Eric Paris (eparis at redhat dot com) based on the kubernetes source material, but hopefully they have been automatically generated since!