blob: c64c53716500be14d967cb1b27f457bd45f4c8bc [file] [log] [blame]
Yuxuan 'fishy' Wang61698b12013-12-20 12:55:51 -08001= kill
Shawn O. Pearce3f1a13a2009-11-20 20:15:41 -08002
Yuxuan 'fishy' Wang61698b12013-12-20 12:55:51 -08003== NAME
Shawn O. Pearce3f1a13a2009-11-20 20:15:41 -08004kill - Cancel or abort a background task
5
Yuxuan 'fishy' Wang61698b12013-12-20 12:55:51 -08006== SYNOPSIS
Yuxuan 'fishy' Wangd85b6872013-11-15 11:47:46 -08007--
Shawn O. Pearce3f1a13a2009-11-20 20:15:41 -08008'ssh' -p <port> <host> 'kill' <ID> ...
Yuxuan 'fishy' Wangd85b6872013-11-15 11:47:46 -08009--
Shawn O. Pearce3f1a13a2009-11-20 20:15:41 -080010
Yuxuan 'fishy' Wang61698b12013-12-20 12:55:51 -080011== DESCRIPTION
Shawn O. Pearce3f1a13a2009-11-20 20:15:41 -080012Cancels a scheduled task from the queue. If the task has already
13been started, requests for the task to cancel as soon as it reaches
14its next cancellation point (which is usually blocking IO).
15
Yuxuan 'fishy' Wang61698b12013-12-20 12:55:51 -080016== ACCESS
Shawn O. Pearce7f485142011-06-16 13:49:42 -070017Caller must be a member of the privileged 'Administrators' group,
Fredrik Luthander46843022012-03-13 16:11:02 +010018or have been granted link:access-control.html#capability_kill[the 'Kill Task' global capability].
Shawn O. Pearce3f1a13a2009-11-20 20:15:41 -080019
Yuxuan 'fishy' Wang61698b12013-12-20 12:55:51 -080020== SCRIPTING
Shawn O. Pearce3f1a13a2009-11-20 20:15:41 -080021Intended for interactive use only.
22
Yuxuan 'fishy' Wangc955b4c2014-03-25 12:34:20 -070023GERRIT
24------
Shawn O. Pearce3f1a13a2009-11-20 20:15:41 -080025Part of link:index.html[Gerrit Code Review]
Yuxuan 'fishy' Wang99cb68d2013-10-31 17:26:00 -070026
27SEARCHBOX
28---------