.\" Macro import for .URL
.mso www.tmac
.\"
.ds rcs_year $Date: 2015/09/08 $
.substring rcs_year 7 10
.\"
.de rcs_version
.\"
.ds rc \\$2
.as rc " 2015.2 "
.as rc "P4DCTL man page"
..
.\"
.rcs_version $Date: 2015/09/08 $
.\" Process this file with
.\" groff -man -Tascii foo.1
.\"
.TH P4DCTL 8 \*[rc]
.SH NAME
p4dctl \- Manage Perforce services
.SH SYNOPSIS

.SS Starting and Stopping Services
.B p4dctl [
.I options
.B ] start [ -t
.I type
.B ] -a 
.br
.B p4dctl [
.I options
.B ] start [ -t
.I type
.B ]
.I servername
.br
.B p4dctl [
.I options
.B ] stop [ -t
.I type
.B ] -a 
.br
.B p4dctl [
.I options
.B ] stop [ -t
.I type
.B ]
.I servername
.br
.B p4dctl [
.I options
.B ] restart [ -t
.I type
.B ] -a 
.br
.B p4dctl [
.I options
.B ] restart [ -t
.I type
.B ]
.I servername

.SS Checkpoints and Journals
.B p4dctl [
.I options
.B ] checkpoint -a
.br
.B p4dctl [
.I options
.B ] checkpoint
.I servername

.SS Queries
.B p4dctl [
.I options
.B ] status [ -t 
.I type
.B ] -a
.br
.B p4dctl [
.I options
.B ] status [ -t 
.I type
.B ]
.I servername
.br
.B p4dctl [
.I options
.B ] list [ -t 
.I type
.B ]
.br
.B p4dctl [
.I options
.B ] list [ -t 
.I type
.B ]
.I servername
.br
.B p4dctl [
.I options
.B ] env [ -t 
.I type
.B ] -a
.I var
.B [
.I var...
.B ]
.br
.B p4dctl [
.I options
.B ] env [ -t 
.I type
.B ]
.I servername
.I var
.B [
.I var...
.B ]

.SH DESCRIPTION
.B P4DCTL
allows administrators to manage Perforce services running on the local host. It 
provides a central place for configuring, starting & stopping all Perforce 
services, and is designed to allow non-root users to administer services they 
own, while root may administer all services, but may not own any.
.SS Privileges & Pidfiles
P4DCTL must be installed as a setuid root executable because it uses root 
privileges to maintain pidfiles for compatibility with systems that use them. 
During all other operations, P4DCTL runs with the privileges of the executing 
user.  This allows non-root users to start/stop the services they own, while 
having the pidfile remain up-to-date.
.P
.SS Environment Control
P4DCTL enforces strict control of the environment of any services it starts. 
Administrators specify the complete environment for each service in the 
configuration file and P4DCTL ensures that the environment for the service is 
exactly what is configured, no more, no less. This prevents the category of 
failure where services work when started by the user, but not when started by 
root. If both use P4DCTL, the environment is always identical.
.SH OPTIONS
.IP "-c config-file"
Path to config file. Default: /etc/perforce/p4dctl.conf
.IP "-p pid_dir"
Path to pid file directory: Default: /var/run
.IP -q
Send output to syslog instead of stdout/stderr
.IP "-v level"
Set debug level (0-9)
.IP -V
Print version and exit
.SH FILES
.I /etc/perforce/p4dctl.conf
.RS
The system wide configuration file. 
.RE
.SH ENVIRONMENT
p4dctl uses no specific environment variables
.SH AUTHOR
.MTO support@perforce.com "Perforce Software"
Tony Smith / Jason Gibson
.br
Copyright (c) 2007-2015 Perforce Software, Inc.
.SH LICENSE
P4DCTL is distributed under the Perforce Open Source License, a
copy of which must be included in all source or binary 
distributions.
.SH "SEE ALSO"
.BR p4dctl.conf (5)
.BR p4 (1),
.BR p4d (1)

The P4DCTL
.URL https://swarm.workshop.perforce.com/projects/perforce-software-p4dctl source
is available, though not guaranteed to be in sync with official binaries.