GitHub
/
pbot
mirror of https://github.com/pragma-/pbot.git
3
0
Fork 0
Code Issues Projects Releases Wiki Activity

Plugin/RunCommand: update header with comments

This commit is contained in:
Pragmatic Software 2021-07-25 18:54:07 -07:00
parent c393976ab1
commit b23860a54c
1 changed files with 15 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
lib/PBot/Plugin/RunCommand.pm
View File

@ -1,6 +1,21 @@
# File: RunCommand.pm
#
# Purpose: Runs a command, streaming each line of output in real-time.
#
# WARNING: The `runcmd` will allow a user to run any command on your system. Do
# not give out the `can-runcmd` capability to anyone you do not trust 100%.
#
# Consider making a locked-down factalias instead; i.e.:
#
# factalias ls runcmd ls $args
# factset ls cap-override can-runcmd
# factset ls locked 1
#
# The above will create an `ls` alias that can only run `runcmd ls $args` and
# cannot be modified by anybody. The cap-override is necessary so the alias
# itself has permission to use `runcmd` regardless of whether the user has the
# `can-runcmd` capability.
# SPDX-FileCopyrightText: 2021 Pragmatic Software <pragma78@gmail.com>
# SPDX-License-Identifier: MIT