NAME

TaskPipe::Tool::Command_StopJob - command to stop a running taskpipe job

PURPOSE

Stop a TaskPipe process. Usually you want to do this because you started a job in the background (using the --shell=background parameter).

DESCRIPTION

For example if earlier you executed the command

    taskpipe run plan --shell=background

and you wanted to stop that job then you should first run

    taskpipe show jobs

use the list which is returned to identify the job id corresponding to the run plan command, then type

    taskpipe stop job --job_id=<insert job id>

Using stop job rather than manually killing processes is recommended where possible, because jobs can involve multiple threads and subprocesses (such as TOR instances) which stop job will attempt to identify and shut down appropriately.

OPTIONS

job_id

The ID of the job you want to stop. To find the job_id, use show jobs.

AUTHOR

Tom Gracey <tomgracey@gmail.com>

COPYRIGHT AND LICENSE

Copyright (c) Tom Gracey 2018

TaskPipe is free software, licensed under

    The GNU Public License Version 3

1 POD Error

The following errors were encountered while parsing the POD:

Around line 71:

You forgot a '=back' before '=head1'