Reformat everything
[nci.git] / nci-list-assignments.1
blobb3f169e2a4d428c7f52add33b6f192719b685716
1 .Dd 2016-06-12
2 .Dt NCI-LIST-ASSIGNMENTS 1
3 .Os
4 .Sh NAME
5 .Nm nci-list-assignments
6 .Nd List available assignments associated to a particular course from a Canvas installation
7 .Sh SYNOPSIS
8 .Nm
9 .Fl c
10 .Ar course-id
11 .Sh DESCRIPTION
12 .Nm
13 connects to a Canvas installation as described at
14 .Xr nci 1
15 and lists all assignments associated to the course
16 .Ar course-id .
17 For each assignment, its
18 .Em id ,
19 .Em name ,
20 .Em maximum point value
21 .Pq if present ,
22 and
23 .Em due date
24 .Pq if present
25 will be printed. For the formating, see
26 .Sx EXAMPLES .
27 .Pp
28 If assignment groups are in place, the assignments will be listed by
29 assignment group, and everything will be ordered as it is stored in
30 Canvas. For assignment groups, the
31 .Em id ,
32 .Em name ,
33 .Em weight
34 .Pq if present ,
35 and
36 .Em grading rules
37 .Pq if present
38 will be printed.
39 .Sh OPTIONS
40 .Bl -tag -width Ds
41 .It Fl c
42 The
43 .Ar course-id ,
44 as returned by
45 .Xr nci-list-courses 1 .
46 .El
47 .Sh EXAMPLES
48 .Dl % nci-list-assignments -c 1187637
49 .Dl 1560872 Homework (10.0%) (Drop 1 lowest)
50 .Dl \& \& 3957825 HW01 (10.0) due at 2016-01-29T04:59:59Z
51 .Dl \& \& 3966363 HW02 (10.0) due at 2016-02-10T04:59:59Z
52 .Dl \& \& 3966366 HW03 (10.0) due at 2016-02-20T04:59:59Z
53 .Dl 1560873 Projects (15.0%)
54 .Dl \& \& 3957826 Project 1 (25.0) due at 2016-02-16T04:59:59Z
55 .Dl \& \& 3966364 Project 2 (25.0) due at 2016-03-10T04:59:59Z
56 .Dl 1560874 Exams (40.0%)
57 .Dl \& \& 3969129 Exam 1 (100.0)
58 .Dl \& \& 4006476 Exam 2 (100.0)
59 .Dl 1560876 Final Exam (35.0%)
60 .Dl \& \& 4014963 Final (200.0)
61 .Sh SEE ALSO
62 .Xr nci 1
63 .Xr nci-list-courses 1
64 .Sh AUTHORS
65 .An S. Gilles Aq Mt sgilles@math.umd.edu