doas.1

   1 .\" $OpenBSD: doas.1,v 1.13 2015/07/26 23:00:15 tedu Exp $
   2 .\"
   3 .\"Copyright (c) 2015 Ted Unangst <tedu@openbsd.org>
   4 .\"
   5 .\"Permission to use, copy, modify, and distribute this software for any
   6 .\"purpose with or without fee is hereby granted, provided that the above
   7 .\"copyright notice and this permission notice appear in all copies.
   8 .\"
   9 .\"THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
  10 .\"WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
  11 .\"MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
  12 .\"ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
  13 .\"WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
  14 .\"ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
  15 .\"OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
  16 .Dd $Mdocdate: July 26 2015 $
  17 .Dt DOAS 1
  18 .Os
  19 .Sh NAME
  20 .Nm doas
  21 .Nd execute commands as another user
  22 .Sh SYNOPSIS
  23 .Nm doas
  24 .Op Fl Lns
  25 .Op Fl C Ar config
  26 .Op Fl u Ar user
  27 .Ar command
  28 .Op Ar args
  29 .Sh DESCRIPTION
  30 The
  31 .Nm
  32 utility executes the given command as another user.
  33 The
  34 .Ar command
  35 argument is mandatory unless
  36 .Fl C
  37 or
  38 .Fl s
  39 is specified.
  40 .Pp
  41 The options are as follows:
  42 .Bl -tag -width tenletters
  43 .It Fl C Ar config
  44 Parse and check the configuration file
  45 .Ar config ,
  46 then exit.
  47 If
  48 .Ar command
  49 is supplied,
  50 .Nm
  51 will also perform command matching.
  52 In the latter case
  53 either
  54 .Sq permit ,
  55 .Sq permit nopass
  56 or
  57 .Sq deny
  58 will be printed on standard output, depending on command
  59 matching results.
  60 No command is executed.
  61 .It Fl L
  62 Clear any persisted authorizations from previous invocations.
  63 .It Fl n
  64 Non interactive mode, fail if
  65 .Nm
  66 would prompt for password.
  67 .It Fl s
  68 Execute the shell from
  69 .Ev SHELL
  70 or
  71 .Pa /etc/passwd .
  72 .It Fl u Ar user
  73 Execute the command as
  74 .Ar user .
  75 The default is root.
  76 .El
  77 .Sh EXIT STATUS
  78 .Ex -std doas
  79 It may fail for one of the following reasons:
  80 .Pp
  81 .Bl -bullet -compact
  82 .It
  83 The config file
  84 .Pa /etc/doas.conf
  85 could not be parsed.
  86 .It
  87 The user attempted to run a command which is not permitted.
  88 .It
  89 The password was incorrect.
  90 .It
  91 The specified command was not found or is not executable.
  92 .El
  93 .Sh SEE ALSO
  94 .Xr su 1 ,
  95 .Xr doas.conf 5
  96 .Sh HISTORY
  97 The
  98 .Nm
  99 command first appeared in
 100 .Ox 5.8 .
 101 .Sh AUTHORS
 102 .An Ted Unangst Aq Mt tedu@openbsd.org