nci-course-settings.1

   1 .Dd 2016-06-12
   2 .Dt NCI-COURSE-SETTINGS 1
   3 .Os
   4 .Sh NAME
   5 .Nm nci-course-settings
   6 .Nd Edit an existing course in a Canvas installation
   7 .Sh SYNOPSIS
   8 .Nm
   9 .Fl c
  10 .Ar course-id
  11 .Oo
  12 .Fl d
  13 |
  14 .Oo
  15 .Fl h
  16 |
  17 .Fl H
  18 .Oc
  19 .Oo
  20 .Fl w
  21 |
  22 .Fl W
  23 .Oc
  24 .Oo
  25 .Fl L
  26 .Oc
  27 .Oo
  28 .Fl s
  29 .Ar start-date
  30 .Oc
  31 .Oo
  32 .Fl e
  33 .Ar end-date
  34 .Oc
  35 .Oo
  36 .Fl C
  37 .Ar cutoffs
  38 .Oc
  39 .Oc
  40 .Sh DESCRIPTION
  41 .Nm
  42 connects to a Canvas installation as described at
  43 .Xr nci 1
  44 and alters some common settings for the given course.
  45 .Sh OPTIONS
  46 .Pp
  47 .Bl -tag -width Ds
  48 .It Fl c
  49 The
  50 .Ar course-id ,
  51 as returned by
  52 .Xr nci-list-courses 1 .
  53 .It Fl d
  54 Get and display options, instead of setting them. Mutually exclusive
  55 with any other option.
  56 .It Fl h Po Fl H Pc
  57 Set
  58 .Ar hide_final_grades
  59 to
  60 .Ar true
  61 .Pq Ar false .
  62 .It Fl w Po Fl W Pc
  63 Set
  64 .Ar apply_assignment_group_weights
  65 to
  66 .Ar true
  67 .Pq Ar false .
  68 .It Fl L
  69 Set
  70 .Ar grading_standard_enabled
  71 .Pq whether letter grades are calculated and displayed
  72 to
  73 .Ar false .
  74 To enable letter grade calculation, use
  75 .Fl C .
  76 This option is mutually exclusive with
  77 .Fl C .
  78 .It Fl s
  79 Set the start date of the course (before this date, the course will be invisible).
  80 .It Fl e
  81 Set the end date of the course (after this date, the course will be invisible).
  82 .It Fl C
  83 Set the cutoffs for letter grade calculation, in the form
  84 .Pp
  85 .Dl Ar letter Ns : Ns Ar minimum-score Ns Oo , Ns Ar letter Ns : Ns Ar minimum-score Ns Oo , Ns Ar letter Ns : Ns Ar minimum-score Ns Oo ... Oc Oc Oc
  86 .Pp
  87 where
  88 .Ar letter
  89 is any string
  90 .Po
  91 not containing
  92 .Sq \&:
  93 .Pc
  94 and
  95 .Ar minimum-score
  96 is a floating point number between 0 and 100. Omitting a letter grade for
  97 .Qq 0.0
  98 appears to cause Canvas to implicitly use the letter grade with the
  99 lowest minimum. These numbers are only relevant to the course if
 100 .Ar grading_standard_enabled
 101 is
 102 .Ar true .
 103 This option is mutually exclusive with
 104 .Fl L .
 105 .El
 106 .Sh EXAMPLES
 107 .Dl % nci-course-settings -c 1187637 -w -H -l
 108 .Pp
 109 .Dl % nci-course-settings -c 1187637 -s 2020-08-25T12:00:00 -e 2021-01-09T12:00:00
 110 .Pp
 111 .Dl % nci-course-settings -c 1187637 -C A:93,A+:97,B:80,C:67.7,A-:90
 112 .Pp
 113 .Dl % nci-course-settings -c 1187637 -d
 114 .Dl Hide final grades: false
 115 .Dl Apply assignment group weights: true
 116 .Dl Grading standard enabled: true
 117 .Dl Start date: 2020-08-25T12:00:00
 118 .Dl End date: 2021-01-09T12:00:00
 119 .Dl Letter grades:
 120 .Dl \& \& A+ Bo 97%, \*(If Pc
 121 .Dl \& \& A \& Bo 93%, 97% Pc
 122 .Dl \& \& A- Bo 90%, 93% Pc
 123 .Dl \& \& B \& Bo 80%, 90% Pc
 124 .Dl \& \& C \& Bo 67.7%, 80% Pc
 125 .Dl \& \& F \& Bo 0%, 67.7% Pc
 126 .Sh SEE ALSO
 127 .Xr nci 1
 128 .Xr nci-list-courses 1
 129 .Sh AUTHORS
 130 .An S. Gilles Aq Mt sgilles@math.umd.edu