Aire-One
/
awesome
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Improve doc for awful.spawn: module/spawn/with_shell

This commit is contained in:
Daniel Hahler 2015-11-05 01:53:43 +01:00
parent 1222b5b5fd
commit a410326ba6
1 changed files with 11 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
lib/awful/spawn.lua
View File

@ -1,4 +1,11 @@
--------------------------------------------------------------------------- ---------------------------------------------------------------------------
--- Spawning of programs.
--
-- This module provides methods to start programs and supports startup
-- notifications, which allows for callbacks and applying properties to the
-- program after it has been launched. This requires currently that the
-- applicaton supports them.
--
-- @author Julien Danjou <julien@danjou.info> -- @author Julien Danjou <julien@danjou.info>
-- @author Emmanuel Lepage Vallee <elv1313@gmail.com> -- @author Emmanuel Lepage Vallee <elv1313@gmail.com>
-- @copyright 2008 Julien Danjou -- @copyright 2008 Julien Danjou
@ -49,8 +56,8 @@ end
-- after startup; `false` to disable startup notifications. -- after startup; `false` to disable startup notifications.
-- @tparam[opt] function callback A callback function to be run after startup. -- @tparam[opt] function callback A callback function to be run after startup.
-- @treturn[1] integer The forked PID. -- @treturn[1] integer The forked PID.
-- @treturn[1] string The startup notification ID, if `sn` is not false, or a -- @treturn[1] ?string The startup notification ID, if `sn` is not false, or
-- `callback` is provided. -- a `callback` is provided.
-- @treturn[2] string Error message. -- @treturn[2] string Error message.
function spawn.spawn(cmd, sn_rules, callback) function spawn.spawn(cmd, sn_rules, callback)
if cmd and cmd ~= "" then if cmd and cmd ~= "" then
@ -73,7 +80,8 @@ function spawn.spawn(cmd, sn_rules, callback)
end end
--- Spawn a program using the shell. --- Spawn a program using the shell.
-- @param cmd The command. -- This calls `cmd` with `$SHELL -c` (via `awful.util.shell`).
-- @tparam string cmd The command.
function spawn.with_shell(cmd) function spawn.with_shell(cmd)
if cmd and cmd ~= "" then if cmd and cmd ~= "" then
cmd = { util.shell, "-c", cmd } cmd = { util.shell, "-c", cmd }