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 .Pq except Fl c .
  57 .It Fl h Po Fl H Pc
  58 Set
  59 .Ar hide_final_grades
  60 to
  61 .Ar true
  62 .Pq Ar false .
  63 .It Fl w Po Fl W Pc
  64 Set
  65 .Ar apply_assignment_group_weights
  66 to
  67 .Ar true
  68 .Pq Ar false .
  69 .It Fl L
  70 Set
  71 .Ar grading_standard_enabled
  72 .Pq whether letter grades are calculated and displayed
  73 to
  74 .Ar false .
  75 To enable letter grade calculation, use
  76 .Fl C .
  77 This option is mutually exclusive with
  78 .Fl C .
  79 .It Fl s
  80 Set the start date of the course (before this date, the course will be invisible).
  81 .It Fl e
  82 Set the end date of the course (after this date, the course will be invisible).
  83 .It Fl C
  84 Set the cutoffs for letter grade calculation, in the form
  85 .Pp
  86 .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
  87 .Pp
  88 where
  89 .Ar letter
  90 is any string
  91 .Po
  92 not containing
  93 .Sq \&:
  94 .Pc
  95 and
  96 .Ar minimum-score
  97 is a floating point number between 0 and 100. Omitting a letter grade for
  98 .Qq 0.0
  99 appears to cause Canvas to implicitly use the letter grade with the
 100 lowest minimum. These numbers are only relevant to the course if
 101 .Ar grading_standard_enabled
 102 is
 103 .Ar true .
 104 This option is mutually exclusive with
 105 .Fl L .
 106 .El
 107 .Sh EXAMPLES
 108 .Dl % nci-course-settings -c 1187637 -w -H -l
 109 .Pp
 110 .Dl % nci-course-settings -c 1187637 -s 2020-08-25T12:00:00 -e 2021-01-09T12:00:00
 111 .Pp
 112 .Dl % nci-course-settings -c 1187637 -C A:93,A+:97,B:80,C:67.7,A-:90
 113 .Pp
 114 .Dl % nci-course-settings -c 1187637 -d
 115 .Dl Hide final grades: false
 116 .Dl Apply assignment group weights: true
 117 .Dl Grading standard enabled: true
 118 .Dl Start date: 2020-08-25T12:00:00
 119 .Dl End date: 2021-01-09T12:00:00
 120 .Dl Letter grades:
 121 .Dl \& \& A+ Bo 97%, \*(If Pc
 122 .Dl \& \& A \& Bo 93%, 97% Pc
 123 .Dl \& \& A- Bo 90%, 93% Pc
 124 .Dl \& \& B \& Bo 80%, 90% Pc
 125 .Dl \& \& C \& Bo 67.7%, 80% Pc
 126 .Dl \& \& F \& Bo 0%, 67.7% Pc
 127 .Sh SEE ALSO
 128 .Xr nci 1
 129 .Xr nci-list-courses 1
 130 .Sh AUTHORS
 131 .An S. Gilles Aq Mt sgilles@math.umd.edu