summaryrefslogtreecommitdiff
path: root/pkg/api/server
diff options
context:
space:
mode:
Diffstat (limited to 'pkg/api/server')
-rw-r--r--pkg/api/server/docs.go7
1 files changed, 7 insertions, 0 deletions
diff --git a/pkg/api/server/docs.go b/pkg/api/server/docs.go
index d9e0a7eba..124c16092 100644
--- a/pkg/api/server/docs.go
+++ b/pkg/api/server/docs.go
@@ -5,6 +5,7 @@
// return values can all change.
//
// To start the service and keep it running for 5,000 seconds (-t 0 runs forever):
+//
// podman system service -t 5000 &
//
// You can then use cURL on the socket using requests documented below.
@@ -15,11 +16,17 @@
// See podman-service(1) for more information.
//
// Quick Examples:
+//
// 'podman info'
+//
// curl --unix-socket /run/podman/podman.sock http://d/v1.0.0/libpod/info
+//
// 'podman pull quay.io/containers/podman'
+//
// curl -XPOST --unix-socket /run/podman/podman.sock -v 'http://d/v1.0.0/images/create?fromImage=quay.io%2Fcontainers%2Fpodman'
+//
// 'podman list images'
+//
// curl --unix-socket /run/podman/podman.sock -v 'http://d/v1.0.0/libpod/images/json' | jq
//
// Terms Of Service: