nci-delete-assignment-group.1

   1 .Dd 2016-06-12
   2 .Dt NCI-DELETE-ASSIGNMENT-GROUP 1
   3 .Os
   4 .Sh NAME
   5 .Nm nci-delete-assignment-group
   6 .Nd Delete a group of assignments in a Canvas installation, optionally moving the stored assignments to another group
   7 .Sh SYNOPSIS
   8 .Nm
   9 .Fl c
  10 .Ar course-id
  11 .Fl g
  12 .Ar group-id
  13 .Oo
  14 .Fl t
  15 .Ar target-group-id
  16 |
  17 .Fl p
  18 .Oc
  19 .Sh DESCRIPTION
  20 .Nm
  21 connects to a Canvas installation as described at
  22 .Xr nci 1
  23 and deletes the assignment group with the given id. If a target group
  24 id is given, Canvas will move all assignments from the deleted group
  25 to the target group. If
  26 .Fl p
  27 is given, the assignments present in the group will be purged.  One of
  28 .Fl p
  29 or
  30 .Fl t
  31 must be provided.
  32 .Sh OPTIONS
  33 .Bl -tag -width Ds
  34 .It Fl c
  35 The
  36 .Ar course-id ,
  37 as returned by
  38 .Xr nci-list-courses 1 .
  39 .It Fl g
  40 The
  41 .Ar group-id
  42 to delete, as returned by
  43 .Xr nci-list-assignments 1 .
  44 .It Fl t
  45 Set the
  46 .Ar target-group-id ,
  47 the id of the assignment group to which to move all assignments in the
  48 to-be-removed group. Mutually exclusive with
  49 .Fl p .
  50 .It Fl p
  51 Purge assignments in this group. Mutually exclusive with
  52 .Fl t .
  53 .El
  54 .Sh EXAMPLES
  55 .Dl % nci-delete-assignment-group -c 1187637 -g 1560872 -p
  56 .Pp
  57 .Dl % nci-delete-assignment-group -c 1187637 -g 1560872 -t 1560882
  58 .Sh SEE ALSO
  59 .Xr nci 1
  60 .Xr nci-create-assignment-group 1
  61 .Xr nci-edit-assignment-group 1
  62 .Xr nci-list-courses 1
  63 .Xr nci-list-assignments 1
  64 .Sh AUTHORS
  65 .An S. Gilles Aq Mt sgilles@math.umd.edu