/usr/share/doc/turnin-ng/turnin-ng.html is in turnin-ng 1.3-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 | <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<!-- This manual is for Turnin-NG (version 1.3, August 27 2014).
Copyright (C) 2009-2014 Ryan Kavanagh (rak@debian.org).
Copying and distribution of this file, with or without modification,
are permitted in any medium without royalty provided the copyright
notice and this notice are preserved. -->
<!-- Created by GNU Texinfo 5.2, http://www.gnu.org/software/texinfo/ -->
<head>
<title>Turnin-NG</title>
<meta name="description" content="Turnin-NG">
<meta name="keywords" content="Turnin-NG">
<meta name="resource-type" content="document">
<meta name="distribution" content="global">
<meta name="Generator" content="makeinfo">
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<link href="#Top" rel="start" title="Top">
<link href="#SEC_Contents" rel="contents" title="Table of Contents">
<link href="dir.html#Top" rel="up" title="(dir)">
<style type="text/css">
<!--
a.summary-letter {text-decoration: none}
blockquote.smallquotation {font-size: smaller}
div.display {margin-left: 3.2em}
div.example {margin-left: 3.2em}
div.indentedblock {margin-left: 3.2em}
div.lisp {margin-left: 3.2em}
div.smalldisplay {margin-left: 3.2em}
div.smallexample {margin-left: 3.2em}
div.smallindentedblock {margin-left: 3.2em; font-size: smaller}
div.smalllisp {margin-left: 3.2em}
kbd {font-style:oblique}
pre.display {font-family: inherit}
pre.format {font-family: inherit}
pre.menu-comment {font-family: serif}
pre.menu-preformatted {font-family: serif}
pre.smalldisplay {font-family: inherit; font-size: smaller}
pre.smallexample {font-size: smaller}
pre.smallformat {font-family: inherit; font-size: smaller}
pre.smalllisp {font-size: smaller}
span.nocodebreak {white-space:nowrap}
span.nolinebreak {white-space:nowrap}
span.roman {font-family:serif; font-weight:normal}
span.sansserif {font-family:sans-serif; font-weight:normal}
ul.no-bullet {list-style: none}
-->
</style>
</head>
<body lang="en" bgcolor="#FFFFFF" text="#000000" link="#0000FF" vlink="#800080" alink="#FF0000">
<h1 class="settitle" align="center">Turnin-NG</h1>
<a name="SEC_Contents"></a>
<h2 class="contents-heading">Table of Contents</h2>
<div class="contents">
<ul class="no-bullet">
<li><a name="toc-Introduction-to-Turnin_002dNG-1" href="#Introduction-to-Turnin_002dNG">1 Introduction to Turnin-NG</a></li>
<li><a name="toc-turnin-1" href="#turnin">2 turnin</a>
<ul class="no-bullet">
<li><a name="toc-Invoking-turnin-1" href="#Invoking-turnin">2.1 Invoking turnin</a></li>
<li><a name="toc-Making-turnin-easier-to-use-1" href="#Making-turnin-easier-to-use">2.2 Making turnin easier to use</a></li>
<li><a name="toc-Examples" href="#Common-situations-for-turnin">2.3 Examples</a></li>
</ul></li>
<li><a name="toc-turnincfg-1" href="#turnincfg">3 turnincfg</a>
<ul class="no-bullet">
<li><a name="toc-Invoking-turnincfg-1" href="#Invoking-turnincfg">3.1 Invoking turnincfg</a></li>
<li><a name="toc-Administration" href="#Common-situations-for-turnincfg">3.2 Administration</a></li>
<li><a name="toc-Examples-1" href="#Examples-1">3.3 Examples</a></li>
</ul></li>
<li><a name="toc-Distributing-Turnin_002dNG-1" href="#Distributing-Turnin_002dNG">4 Distributing Turnin-NG</a>
<ul class="no-bullet">
<li><a name="toc-GNU-General-Public-License-version-2-1" href="#GNU-General-Public-License-version-2">4.1 GNU General Public License version 2</a></li>
</ul></li>
</ul>
</div>
<a name="Top"></a>
<div class="header">
<p>
Next: <a href="#Introduction-to-Turnin_002dNG" accesskey="n" rel="next">Introduction to Turnin-NG</a>, Previous: <a href="dir.html#Top" accesskey="p" rel="prev">(dir)</a>, Up: <a href="dir.html#Top" accesskey="u" rel="up">(dir)</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>]</p>
</div>
<a name="Turnin_002dNG"></a>
<h1 class="top">Turnin-NG</h1>
<p>This manual is for Turnin-NG (version 1.3, August 27 2014).
</p>
<p>Copyright © 2009–2014 Ryan Kavanagh (<a href="mailto:rak@debian.org">rak@debian.org</a>).
</p>
<blockquote>
<p>Copying and distribution of this file, with or without modification,
are permitted in any medium without royalty provided the copyright
notice and this notice are preserved.
</p></blockquote>
<table class="menu" border="0" cellspacing="0">
<tr><td align="left" valign="top">• <a href="#Introduction-to-Turnin_002dNG" accesskey="1">Introduction to Turnin-NG</a>:</td><td> </td><td align="left" valign="top">
</td></tr>
<tr><td align="left" valign="top">• <a href="#turnin" accesskey="2">turnin</a>:</td><td> </td><td align="left" valign="top">
</td></tr>
<tr><td align="left" valign="top">• <a href="#turnincfg" accesskey="3">turnincfg</a>:</td><td> </td><td align="left" valign="top">
</td></tr>
<tr><td align="left" valign="top">• <a href="#Distributing-Turnin_002dNG" accesskey="4">Distributing Turnin-NG</a>:</td><td> </td><td align="left" valign="top">
</td></tr>
</table>
<hr>
<a name="Introduction-to-Turnin_002dNG"></a>
<div class="header">
<p>
Next: <a href="#turnin" accesskey="n" rel="next">turnin</a>, Previous: <a href="#Top" accesskey="p" rel="prev">Top</a>, Up: <a href="#Top" accesskey="u" rel="up">Top</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>]</p>
</div>
<a name="Introduction-to-Turnin_002dNG-1"></a>
<h2 class="chapter">1 Introduction to Turnin-NG</h2>
<p>Turnin-NG is an assignment submission suite written in Python and composed of
<code>turnin</code> and <code>turnincfg</code>. Students can use the <code>turnin</code>
command to submit an assignment to a course. Professors and <acronym title="teaching assistants">TAs</acronym> (teaching assistants) can use <code>turnincfg</code> to manage submitted
assignments, making them easier to grade.
</p>
<hr>
<a name="turnin"></a>
<div class="header">
<p>
Next: <a href="#turnincfg" accesskey="n" rel="next">turnincfg</a>, Previous: <a href="#Introduction-to-Turnin_002dNG" accesskey="p" rel="prev">Introduction to Turnin-NG</a>, Up: <a href="#Top" accesskey="u" rel="up">Top</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>]</p>
</div>
<a name="turnin-1"></a>
<h2 class="chapter">2 turnin</h2>
<p><code>turnin</code> compresses your assignments using the <code>tar</code> and
<code>gzip</code> formats before submitting them to be graded. If you feel so
inclined, <code>turnin</code> can cryptographically sign your assignments using
<code>GnuPG</code> to prevent someone from submitting an assignment in your name.
</p>
<table class="menu" border="0" cellspacing="0">
<tr><td align="left" valign="top">• <a href="#Invoking-turnin" accesskey="1">Invoking turnin</a>:</td><td> </td><td align="left" valign="top">
</td></tr>
<tr><td align="left" valign="top">• <a href="#Making-turnin-easier-to-use" accesskey="2">Making turnin easier to use</a>:</td><td> </td><td align="left" valign="top">
</td></tr>
<tr><td align="left" valign="top">• <a href="#Common-situations-for-turnin" accesskey="3">Common situations for turnin</a>:</td><td> </td><td align="left" valign="top">
</td></tr>
</table>
<hr>
<a name="Invoking-turnin"></a>
<div class="header">
<p>
Next: <a href="#Making-turnin-easier-to-use" accesskey="n" rel="next">Making turnin easier to use</a>, Previous: <a href="#turnin" accesskey="p" rel="prev">turnin</a>, Up: <a href="#turnin" accesskey="u" rel="up">turnin</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>]</p>
</div>
<a name="Invoking-turnin-1"></a>
<h3 class="section">2.1 Invoking turnin</h3>
<p><code>turnin</code> was designed with ease of use in mind, all while retaining the
functionality of the original <code>turnin</code> command.
</p>
<p>The command line format for turnin is as follows.
</p>
<p><code>
<code>turnin</code> [ -vhlw ] [ --version ] [ -p <var>project</var> ] [ -C <var>config</var> ]
[ -k <var>keyid</var> ] -c <var>course</var> files
</code>
</p>
<p>You must provide the course name and a list of files to submit.
</p>
<dl compact="compact">
<dt><code><samp>-v</samp>, <samp>--verbose</samp></code></dt>
<dd><p>Print a list of submitted files once they have been submitted.
</p>
</dd>
<dt><code><samp>-h</samp>, <samp>--help</samp></code></dt>
<dd><p>Print a help message.
</p>
</dd>
<dt><code><samp>-l</samp>, <samp>--list</samp></code></dt>
<dd><p>Print a list of projects, along with whether or not they are enabled and if the
project is the default project.
</p>
</dd>
<dt><code><samp>--version</samp></code></dt>
<dd><p>Print turnin’s version.
</p>
</dd>
<dt><code><samp>-p</samp>, <samp>--project</samp></code></dt>
<dd><p>Set the project to which we’ll submit our assignments. The project must be
enabled. If we do not pass this option, <code>turnin</code> will submit to the
<tt class="key">Default</tt> project listed by the <samp>-l</samp> or <samp>--list</samp> option.
</p>
</dd>
<dt><code><samp>-C</samp>, <samp>--config</samp></code></dt>
<dd><p>Path to an alternate configuration file.
</p>
</dd>
<dt><code><samp>-k</samp>, <samp>--keyid</samp></code></dt>
<dd><p>Cryptographically sign an assignment using <code>gpg</code>.
</p>
</dd>
<dt><code><samp>-c</samp>, <samp>--course</samp></code></dt>
<dd><p>Set the course to which we’ll submit our assignments.
</p>
</dd>
<dt><code><samp>-w</samp>, <samp>--legal</samp></code></dt>
<dd><p>Print warranty and license information.
</p>
</dd>
<dt><code><samp>files</samp></code></dt>
<dd><p>The files and directories we want to submit
</p></dd>
</dl>
<hr>
<a name="Making-turnin-easier-to-use"></a>
<div class="header">
<p>
Next: <a href="#Common-situations-for-turnin" accesskey="n" rel="next">Common situations for turnin</a>, Previous: <a href="#Invoking-turnin" accesskey="p" rel="prev">Invoking turnin</a>, Up: <a href="#turnin" accesskey="u" rel="up">turnin</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>]</p>
</div>
<a name="Making-turnin-easier-to-use-1"></a>
<h3 class="section">2.2 Making turnin easier to use</h3>
<p>You can use your shell’s built in <code>alias</code> command to reduce the typing
required when using <code>turnin</code>. These aliases should be appended to your
shell’s configuration file (<samp>$HOME/.profile</samp> for Bourne compatible shells).
If you are only in one course, you could use the following alias:
</p>
<div class="example">
<pre class="example"><code>alias turnin='turnin -c YOUR_COURSE'</code>
</pre></div>
<p>If you are in multiple courses, the following aliases may be useful:
</p>
<div class="example">
<pre class="example"><code>alias turnin-COURSE1='turnin -c COURSE1'</code>
<code>alias turnin-COURSE2='turnin -c COURSE2'</code>
<code># ...</code>
<code>alias turnin-COURSEX='turnin -c COURSEX'</code>
</pre></div>
<p>If you want to always sign your assignments before submitting them, you could
use an alias like this one:
</p>
<div class="example">
<pre class="example"><code>alias turnin='turnin -k E95EDDC9'</code>
</pre></div>
<p>Just make sure to replace the text in capitals with the appropriate information
and ’E95EDDC9’ with your GnuPG key id.
</p>
<hr>
<a name="Common-situations-for-turnin"></a>
<div class="header">
<p>
Previous: <a href="#Making-turnin-easier-to-use" accesskey="p" rel="prev">Making turnin easier to use</a>, Up: <a href="#turnin" accesskey="u" rel="up">turnin</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>]</p>
</div>
<a name="Examples"></a>
<h3 class="section">2.3 Examples</h3>
<p>You want to submit an assignment, the files <samp>bubblesort.hs</samp> and
<samp>radixsort.hs</samp> to the course ‘cisc2323’, but you aren’t sure of the project
name. You start by finding the project list. To do this, you need to pass
the <samp>-l</samp> option to turnin, along with the required <samp>-c
<var>coursename</var></samp> argument.
</p>
<div class="smallexample">
<pre class="smallexample"><code>
ryanakca@zeus:~$ turnin -c cisc2323 -l
------------------------------------------------------------------------------------
| Enabled | Project | Description |
------------------------------------------------------------------------------------
| False | searching | Implement a binary search |
| True | haskell_sort | Implement the bubble sort and the radix sort in Haskell |
| Default | bake | Bake cookies for the professor |
| True | museum_guard | Write a paper about the museum guard problem |
| False | packing | Implement a packing algorithm |
------------------------------------------------------------------------------------</code>
</pre></div>
<p>You see that you want the <samp>haskell_sort</samp> project. Since it is not the
default project, we will have to pass the <samp>-p <var>project</var></samp> option, in
this case, <samp>-p <var>haskell_sort</var></samp>, to turnin when we invoke it.
</p>
<p>We now proceed to submit our assignments.
</p><div class="smallexample">
<pre class="smallexample"><code>
ryanakca@zeus:~$ turnin -c cisc2323 -p haskell_sort bubblesort.hs radixsort.hs
Successfully submitted your assignment for grading.
</code>
</pre></div>
<p>If we want to make sure <code>turnin</code> did not forget a file, we can pass the
<samp>-v</samp> or <samp>--verbose</samp> option when we invoke it.
</p>
<div class="smallexample">
<pre class="smallexample"><code>
ryanakca@zeus:~$ turnin -c cisc2323 -p haskell_sort -v bubblesort.hs radixsort.hs
Submitted files:
sort-ryanakca
sort-ryanakca/bubblesort.hs
sort-ryanakca/radixsort.hs
</code>
</pre></div>
<p>We decide that we had wanted to sign our submission, we can do so by passing the
<samp>-k <var>KEYID</var></samp>.
</p>
<div class="smallexample">
<pre class="smallexample"><code>
ryanakca@zeus:~$ turnin -c cisc-2323 -p haskell_sort -kD295EAC1 \
> bubblesort.hs radixsort.hs
You need a passphrase to unlock the secret key for
user: "Ryan Kavanagh <ryanakca@kubuntu.org>"
1024-bit RSA key, ID D295EAC1, created 2009-07-13
gpg: gpg-agent is not available in this session
Successfully submitted your assignment for grading.
</code>
</pre></div>
<p>If the project is still enabled and we want to resubmit our assignment, we may
do so by rerunning the <code>turnin</code> command.
</p>
<hr>
<a name="turnincfg"></a>
<div class="header">
<p>
Next: <a href="#Distributing-Turnin_002dNG" accesskey="n" rel="next">Distributing Turnin-NG</a>, Previous: <a href="#turnin" accesskey="p" rel="prev">turnin</a>, Up: <a href="#Top" accesskey="u" rel="up">Top</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>]</p>
</div>
<a name="turnincfg-1"></a>
<h2 class="chapter">3 turnincfg</h2>
<p>Turnin-NG’s <code>turnincfg</code> command retains most of the functionality of the
original <code>project</code> command and seeks to make assignment management as
easy as possible. To make file management and storage as easy and efficient as
possible, each submission is compressed using the <code>tar</code> and
<code>gzip</code> formats.
</p>
<table class="menu" border="0" cellspacing="0">
<tr><td align="left" valign="top">• <a href="#Invoking-turnincfg" accesskey="1">Invoking turnincfg</a>:</td><td> </td><td align="left" valign="top">
</td></tr>
<tr><td align="left" valign="top">• <a href="#Common-situations-for-turnincfg" accesskey="2">Common situations for turnincfg</a>:</td><td> </td><td align="left" valign="top">
</td></tr>
</table>
<hr>
<a name="Invoking-turnincfg"></a>
<div class="header">
<p>
Next: <a href="#Common-situations-for-turnincfg" accesskey="n" rel="next">Common situations for turnincfg</a>, Previous: <a href="#turnincfg" accesskey="p" rel="prev">turnincfg</a>, Up: <a href="#turnincfg" accesskey="u" rel="up">turnincfg</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>]</p>
</div>
<a name="Invoking-turnincfg-1"></a>
<h3 class="section">3.1 Invoking turnincfg</h3>
<p>The author of Turnin-NG strived to make <code>turnincfg</code> as easy to use, all
while retaining the used functionality of the original <code>project</code>
command.
</p>
<p>The command line format for turnincfg is as follows.
</p>
<p><code>
<code>turnincfg</code> [ -hdelripxvw ] [--version] [ -C <var>config</var> ] [ -c
<var>course</var> ] [ --create-course <var>course</var> ] [ --delete-course <var>course</var> ]
[ --archive-course <var>course</var> ] [ <var>project name</var> ]
</code>
</p>
<dl compact="compact">
<dt><code><samp>--version</samp></code></dt>
<dd><p>Print <code>turnincfg</code>’s version.
</p>
</dd>
<dt><code><samp>-h</samp>, <samp>--help</samp></code></dt>
<dd><p>Print a help message.
</p>
</dd>
<dt><code><samp>-D</samp>, <samp>--perm-disable</samp></code></dt>
<dd><p>Permanently disable the current project and strip all unique suffixes. You will
generally want to use this option instead of <samp>--disable</samp>.
</p>
</dd>
<dt><code><samp>-d</samp>, <samp>--disable</samp></code></dt>
<dd><p>Disable the current project.
</p>
</dd>
<dt><code><samp>-e</samp>, <samp>--enable</samp></code></dt>
<dd><p>Enable submissions for the current project and make it the default project.
</p>
</dd>
<dt><code><samp>-l</samp></code></dt>
<dd><p>Enable submissions for the current project but don’t make it default.
</p>
</dd>
<dt><code><samp>-r</samp>, <samp>--remove</samp></code></dt>
<dd><p>Remove the current project and all associated files.
</p>
</dd>
<dt><code><samp>-i</samp>, <samp>--init</samp></code></dt>
<dd><p>Initialize this project.
</p>
</dd>
<dt><code><samp>-p</samp>, <samp>--compress</samp></code></dt>
<dd><p>Compress this project using the <code>tar</code> and <code>gzip</code> formats.
</p>
</dd>
<dt><code><samp>-x</samp>, <samp>--extract</samp></code></dt>
<dd><p>Extract this project.
</p>
</dd>
<dt><code><samp>-v</samp>, <samp>--verify</samp></code></dt>
<dd><p>Verify <code>GnuPG</code> signatures on submitted projects.
</p>
</dd>
<dt><code><samp>-C</samp>, <samp>--config</samp></code></dt>
<dd><p>Path to an alternate configuration file. The default configuration file is
<samp>/etc/turnin-ng.cf</samp>.
</p>
</dd>
<dt><code><samp>-w</samp>, <samp>--legal</samp></code></dt>
<dd><p>Print warranty and license information.
</p>
</dd>
<dt><code><samp>--create-course</samp></code></dt>
<dd><p>Create a course.
</p>
</dd>
<dt><code><samp>--delete-course</samp></code></dt>
<dd><p>Delete a course and all associated files.
</p>
</dd>
<dt><code><samp>--archive-course</samp></code></dt>
<dd><p>Archive a course using the <code>tar</code> and <code>gzip</code> formats to create a
<samp>.tar.gz</samp> file.
</p></dd>
</dl>
<hr>
<a name="Common-situations-for-turnincfg"></a>
<div class="header">
<p>
Previous: <a href="#Invoking-turnincfg" accesskey="p" rel="prev">Invoking turnincfg</a>, Up: <a href="#turnincfg" accesskey="u" rel="up">turnincfg</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>]</p>
</div>
<a name="Administration"></a>
<h3 class="section">3.2 Administration</h3>
<p>A course (or many!) needs to be created by an administrator before users can use
the <code>turnincfg</code> and <code>turnin</code> commands.
</p>
<p>There are two styles of course management: user managed and group managed. With
user managed courses, all project management actions are done with a single
account. With group management, project management actions are done by accounts
in a UNIX group. The original <code>project</code> and <code>turnin</code> commands
only supported user managed courses.
</p>
<p>Due to the limited granularity of UNIX permissions, group managed courses permit
submissions from all accounts.
</p>
<p>The following example shows the creation of a user managed course.
</p>
<div class="smallexample">
<pre class="smallexample"><code>
root@zeus:~$ turnincfg --create-course cisc2323
Managing username [usually your UNIX login]: ryanakca
Full path to the course directory: /srv/submit/cisc2323
Managed by a User or Group [U/G]: U
Student group: students
Please make sure the account ryanakca is a member of the group students.
Successfully created the course cisc-2323.
</code>
</pre></div>
<p>This creates a directory with the permissions and contents:
</p><div class="smallexample">
<pre class="smallexample"><code>
ryanakca@zeus:~$ ls -lash /srv/submit/cisc2323
total 4,0K
0 drwxr-xr-x 2 ryanakca students 60 19 Aug 13:01 ./
0 drwxrwxrwt 17 root root 400 19 Aug 13:12 ../
4,0K -rw-r--r-- 1 ryanakca students 134 19 Aug 13:01 turnin-ng.cf
</code>
</pre></div>
<p>Submission subdirectories for enabled projects will have the permissions
<code>0770</code> and an ownership of <code>MANAGING_USERNAME:STUDENT_GROUP</code>. Once
disabled, they will have the permissions <code>0700</code>.
</p>
<p>The following example shows the creation of a group managed course. In this
case, we’ll set the managing username to the professor’s account and the
managing group to the group containing the course’s professor and TAs.
</p>
<div class="smallexample">
<pre class="smallexample"><code>
root@zeus:~$ turnincfg --create-course cisc2323
Managing username [usually your UNIX login]: ryanakca
Full path to the course directory: /srv/submit/cisc2323
Managed by a User or Group [U/G]: G
Managing group: cisc-2323
Successfully created the course cisc-2323.
</code>
</pre></div>
<p>This creates a directory with the permissions and contents:
</p><div class="smallexample">
<pre class="smallexample"><code>
total 4,0K
0 drwxrwxr-x 2 ryanakca cisc-2323 60 19 Aug 13:25 ./
0 drwxrwxrwt 18 root root 420 19 Aug 13:25 ../
4,0K -rw-rw-r-- 1 ryanakca cisc-2323 121 19 Aug 13:25 turnin-ng.cf
</code>
</pre></div>
<p>Submission subdirectories for enabled projects will have the permissions
<code>0777</code> and an ownership of <code>MANAGING_USERNAME:MANAGING_GROUP</code>. Once
disabled, they will have the permissions <code>0770</code>.
</p>
<p>Once a course has finished, you may remove it from the global configuration file
and delete all files in its directory by running the command <code>turnincfg
--delete-course <var>COURSENAME</var></code>. If you would rather keep its files
and still remove it from the global configuration file, you can run
<code>turnincfg --archive-course <var>COURSENAME</var></code>. This will create
a <samp>.tar.gz</samp> file containing the course directory.
</p>
<a name="Examples-1"></a>
<h3 class="section">3.3 Examples</h3>
<p>You’re the professor for the course cisc2323 and want to create the project
‘haskell_sort’ for your students, enable submissions for it and make it the
default project (the default project is the project to which <code>turnin</code>
submits assignments if the student doesn’t pass the <samp>--project
<var>PROJECT</var></samp> option when invoking <code>turnin</code>).
</p>
<div class="smallexample">
<pre class="smallexample"><code>
ryanakca@zeus:~$ turnincfg -i haskell_sort
[Optional] Project description: Implement a bubble sort and the radix sort using Haskell
Successfully created the project haskell_sort in the course cisc2323
ryanakca@zeus:~$ turnincfg -e haskell_sort
Successfully enabled and set default the project haskell_sort
</code>
</pre></div>
<p>In the previous example, we created the project <samp>haskell_sort</samp> by running
the command <code>turnincfg -i haskell_sort</code>. Finally, we enabled it and set
it default by running <code>turnincfg -e haskell_sort</code>.
</p>
<p>We want to close submissions for the project ‘haskell_sort’ and compress it at
24:00 UTC, September 15 2009. We can do this using the <code>at</code> command.
</p>
<div class="smallexample">
<pre class="smallexample"><code>
ryanakca@zeus:~$ at 2400 UTC Sep 15 2009
warning: commands will be executed using /bin/sh
at> turnincfg -c cisc2323
at> turnincfg -D haskell_sort
at> turnincfg -p haskell_sort
job 92 at Tue Sep 15 19:00:00 2009
</code>
</pre></div>
<p>For more details on <code>at</code>’s time format, please see it’s <code>man</code>
page. In this case we passed the <code>turnincfg -D haskell_sort</code> command
instead of the <code>turnincfg -d haskell_sort</code> command since we do not want
the long suffixed file names in the archive, we want them in the
<samp>username.tar.gz</samp> format.
</p>
<hr>
<a name="Distributing-Turnin_002dNG"></a>
<div class="header">
<p>
Previous: <a href="#turnincfg" accesskey="p" rel="prev">turnincfg</a>, Up: <a href="#Top" accesskey="u" rel="up">Top</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>]</p>
</div>
<a name="Distributing-Turnin_002dNG-1"></a>
<h2 class="chapter">4 Distributing Turnin-NG</h2>
<p>Turnin-NG is Copyright © 2009–2010 Ryan Kavanagh
(<a href="mailto:rak@debian.org">rak@debian.org</a>). It is licensed under the terms of the GNU
General Public License version 2, or (at your option) any later version.
</p>
<table class="menu" border="0" cellspacing="0">
<tr><td align="left" valign="top">• <a href="#GNU-General-Public-License-version-2" accesskey="1">GNU General Public License version 2</a>:</td><td> </td><td align="left" valign="top">
</td></tr>
</table>
<hr>
<a name="GNU-General-Public-License-version-2"></a>
<div class="header">
<p>
Up: <a href="#Distributing-Turnin_002dNG" accesskey="u" rel="up">Distributing Turnin-NG</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>]</p>
</div>
<a name="GNU-General-Public-License-version-2-1"></a>
<h3 class="section">4.1 GNU General Public License version 2</h3>
<div align="center">Version 2, June 1991
</div>
<div class="display">
<pre class="display">Copyright © 1989, 1991 Free Software Foundation, Inc.
51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
Everyone is permitted to copy and distribute verbatim copies
of this license document, but changing it is not allowed.
</pre></div>
<a name="Preamble"></a>
<h3 class="heading">Preamble</h3>
<p>The licenses for most software are designed to take away your
freedom to share and change it. By contrast, the GNU General Public
License is intended to guarantee your freedom to share and change free
software—to make sure the software is free for all its users. This
General Public License applies to most of the Free Software
Foundation’s software and to any other program whose authors commit to
using it. (Some other Free Software Foundation software is covered by
the GNU Lesser General Public License instead.) You can apply it to
your programs, too.
</p>
<p>When we speak of free software, we are referring to freedom, not
price. Our General Public Licenses are designed to make sure that you
have the freedom to distribute copies of free software (and charge for
this service if you wish), that you receive source code or can get it
if you want it, that you can change the software or use pieces of it
in new free programs; and that you know you can do these things.
</p>
<p>To protect your rights, we need to make restrictions that forbid
anyone to deny you these rights or to ask you to surrender the rights.
These restrictions translate to certain responsibilities for you if you
distribute copies of the software, or if you modify it.
</p>
<p>For example, if you distribute copies of such a program, whether
gratis or for a fee, you must give the recipients all the rights that
you have. You must make sure that they, too, receive or can get the
source code. And you must show them these terms so they know their
rights.
</p>
<p>We protect your rights with two steps: (1) copyright the software, and
(2) offer you this license which gives you legal permission to copy,
distribute and/or modify the software.
</p>
<p>Also, for each author’s protection and ours, we want to make certain
that everyone understands that there is no warranty for this free
software. If the software is modified by someone else and passed on, we
want its recipients to know that what they have is not the original, so
that any problems introduced by others will not reflect on the original
authors’ reputations.
</p>
<p>Finally, any free program is threatened constantly by software
patents. We wish to avoid the danger that redistributors of a free
program will individually obtain patent licenses, in effect making the
program proprietary. To prevent this, we have made it clear that any
patent must be licensed for everyone’s free use or not licensed at all.
</p>
<p>The precise terms and conditions for copying, distribution and
modification follow.
</p>
<a name="TERMS-AND-CONDITIONS-FOR-COPYING_002c-DISTRIBUTION-AND-MODIFICATION"></a>
<h3 class="heading">TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION</h3>
<ol>
<li> This License applies to any program or other work which contains
a notice placed by the copyright holder saying it may be distributed
under the terms of this General Public License. The “Program”, below,
refers to any such program or work, and a “work based on the Program”
means either the Program or any derivative work under copyright law:
that is to say, a work containing the Program or a portion of it,
either verbatim or with modifications and/or translated into another
language. (Hereinafter, translation is included without limitation in
the term “modification”.) Each licensee is addressed as “you”.
<p>Activities other than copying, distribution and modification are not
covered by this License; they are outside its scope. The act of
running the Program is not restricted, and the output from the Program
is covered only if its contents constitute a work based on the
Program (independent of having been made by running the Program).
Whether that is true depends on what the Program does.
</p>
</li><li> You may copy and distribute verbatim copies of the Program’s
source code as you receive it, in any medium, provided that you
conspicuously and appropriately publish on each copy an appropriate
copyright notice and disclaimer of warranty; keep intact all the
notices that refer to this License and to the absence of any warranty;
and give any other recipients of the Program a copy of this License
along with the Program.
<p>You may charge a fee for the physical act of transferring a copy, and
you may at your option offer warranty protection in exchange for a fee.
</p>
</li><li> You may modify your copy or copies of the Program or any portion
of it, thus forming a work based on the Program, and copy and
distribute such modifications or work under the terms of Section 1
above, provided that you also meet all of these conditions:
<ol>
<li> You must cause the modified files to carry prominent notices
stating that you changed the files and the date of any change.
</li><li> You must cause any work that you distribute or publish, that in
whole or in part contains or is derived from the Program or any
part thereof, to be licensed as a whole at no charge to all third
parties under the terms of this License.
</li><li> If the modified program normally reads commands interactively
when run, you must cause it, when started running for such
interactive use in the most ordinary way, to print or display an
announcement including an appropriate copyright notice and a
notice that there is no warranty (or else, saying that you provide
a warranty) and that users may redistribute the program under
these conditions, and telling the user how to view a copy of this
License. (Exception: if the Program itself is interactive but
does not normally print such an announcement, your work based on
the Program is not required to print an announcement.)
</li></ol>
<p>These requirements apply to the modified work as a whole. If
identifiable sections of that work are not derived from the Program,
and can be reasonably considered independent and separate works in
themselves, then this License, and its terms, do not apply to those
sections when you distribute them as separate works. But when you
distribute the same sections as part of a whole which is a work based
on the Program, the distribution of the whole must be on the terms of
this License, whose permissions for other licensees extend to the
entire whole, and thus to each and every part regardless of who wrote it.
</p>
<p>Thus, it is not the intent of this section to claim rights or contest
your rights to work written entirely by you; rather, the intent is to
exercise the right to control the distribution of derivative or
collective works based on the Program.
</p>
<p>In addition, mere aggregation of another work not based on the Program
with the Program (or with a work based on the Program) on a volume of
a storage or distribution medium does not bring the other work under
the scope of this License.
</p>
</li><li> You may copy and distribute the Program (or a work based on it,
under Section 2) in object code or executable form under the terms of
Sections 1 and 2 above provided that you also do one of the following:
<ol>
<li> Accompany it with the complete corresponding machine-readable
source code, which must be distributed under the terms of Sections
1 and 2 above on a medium customarily used for software interchange; or,
</li><li> Accompany it with a written offer, valid for at least three
years, to give any third party, for a charge no more than your
cost of physically performing source distribution, a complete
machine-readable copy of the corresponding source code, to be
distributed under the terms of Sections 1 and 2 above on a medium
customarily used for software interchange; or,
</li><li> Accompany it with the information you received as to the offer
to distribute corresponding source code. (This alternative is
allowed only for noncommercial distribution and only if you
received the program in object code or executable form with such
an offer, in accord with Subsection b above.)
</li></ol>
<p>The source code for a work means the preferred form of the work for
making modifications to it. For an executable work, complete source
code means all the source code for all modules it contains, plus any
associated interface definition files, plus the scripts used to
control compilation and installation of the executable. However, as a
special exception, the source code distributed need not include
anything that is normally distributed (in either source or binary
form) with the major components (compiler, kernel, and so on) of the
operating system on which the executable runs, unless that component
itself accompanies the executable.
</p>
<p>If distribution of executable or object code is made by offering
access to copy from a designated place, then offering equivalent
access to copy the source code from the same place counts as
distribution of the source code, even though third parties are not
compelled to copy the source along with the object code.
</p>
</li><li> You may not copy, modify, sublicense, or distribute the Program
except as expressly provided under this License. Any attempt
otherwise to copy, modify, sublicense or distribute the Program is
void, and will automatically terminate your rights under this License.
However, parties who have received copies, or rights, from you under
this License will not have their licenses terminated so long as such
parties remain in full compliance.
</li><li> You are not required to accept this License, since you have not
signed it. However, nothing else grants you permission to modify or
distribute the Program or its derivative works. These actions are
prohibited by law if you do not accept this License. Therefore, by
modifying or distributing the Program (or any work based on the
Program), you indicate your acceptance of this License to do so, and
all its terms and conditions for copying, distributing or modifying
the Program or works based on it.
</li><li> Each time you redistribute the Program (or any work based on the
Program), the recipient automatically receives a license from the
original licensor to copy, distribute or modify the Program subject to
these terms and conditions. You may not impose any further
restrictions on the recipients’ exercise of the rights granted herein.
You are not responsible for enforcing compliance by third parties to
this License.
</li><li> If, as a consequence of a court judgment or allegation of patent
infringement or for any other reason (not limited to patent issues),
conditions are imposed on you (whether by court order, agreement or
otherwise) that contradict the conditions of this License, they do not
excuse you from the conditions of this License. If you cannot
distribute so as to satisfy simultaneously your obligations under this
License and any other pertinent obligations, then as a consequence you
may not distribute the Program at all. For example, if a patent
license would not permit royalty-free redistribution of the Program by
all those who receive copies directly or indirectly through you, then
the only way you could satisfy both it and this License would be to
refrain entirely from distribution of the Program.
<p>If any portion of this section is held invalid or unenforceable under
any particular circumstance, the balance of the section is intended to
apply and the section as a whole is intended to apply in other
circumstances.
</p>
<p>It is not the purpose of this section to induce you to infringe any
patents or other property right claims or to contest validity of any
such claims; this section has the sole purpose of protecting the
integrity of the free software distribution system, which is
implemented by public license practices. Many people have made
generous contributions to the wide range of software distributed
through that system in reliance on consistent application of that
system; it is up to the author/donor to decide if he or she is willing
to distribute software through any other system and a licensee cannot
impose that choice.
</p>
<p>This section is intended to make thoroughly clear what is believed to
be a consequence of the rest of this License.
</p>
</li><li> If the distribution and/or use of the Program is restricted in
certain countries either by patents or by copyrighted interfaces, the
original copyright holder who places the Program under this License
may add an explicit geographical distribution limitation excluding
those countries, so that distribution is permitted only in or among
countries not thus excluded. In such case, this License incorporates
the limitation as if written in the body of this License.
</li><li> The Free Software Foundation may publish revised and/or new versions
of the General Public License from time to time. Such new versions will
be similar in spirit to the present version, but may differ in detail to
address new problems or concerns.
<p>Each version is given a distinguishing version number. If the Program
specifies a version number of this License which applies to it and “any
later version”, you have the option of following the terms and conditions
either of that version or of any later version published by the Free
Software Foundation. If the Program does not specify a version number of
this License, you may choose any version ever published by the Free Software
Foundation.
</p>
</li><li> If you wish to incorporate parts of the Program into other free
programs whose distribution conditions are different, write to the author
to ask for permission. For software which is copyrighted by the Free
Software Foundation, write to the Free Software Foundation; we sometimes
make exceptions for this. Our decision will be guided by the two goals
of preserving the free status of all derivatives of our free software and
of promoting the sharing and reuse of software generally.
</li><li> BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY
FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN
OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES
PROVIDE THE PROGRAM “AS IS” WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED
OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS
TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE
PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING,
REPAIR OR CORRECTION.
</li><li> IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR
REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES,
INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING
OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED
TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY
YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER
PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE
POSSIBILITY OF SUCH DAMAGES.
</li></ol>
<a name="Appendix_003a-How-to-Apply-These-Terms-to-Your-New-Programs"></a>
<h3 class="heading">Appendix: How to Apply These Terms to Your New Programs</h3>
<p>If you develop a new program, and you want it to be of the greatest
possible use to the public, the best way to achieve this is to make it
free software which everyone can redistribute and change under these terms.
</p>
<p>To do so, attach the following notices to the program. It is safest
to attach them to the start of each source file to most effectively
convey the exclusion of warranty; and each file should have at least
the “copyright” line and a pointer to where the full notice is found.
</p>
<div class="smallexample">
<pre class="smallexample"><var>one line to give the program's name and a brief idea of what it does.</var>
Copyright (C) <var>yyyy</var> <var>name of author</var>
This program is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 2 of the License, or
(at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program; if not, write to the Free Software
Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
</pre></div>
<p>Also add information on how to contact you by electronic and paper mail.
</p>
<p>If the program is interactive, make it output a short notice like this
when it starts in an interactive mode:
</p>
<div class="smallexample">
<pre class="smallexample">Gnomovision version 69, Copyright (C) <var>year</var> <var>name of author</var>
Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
This is free software, and you are welcome to redistribute it
under certain conditions; type `show c' for details.
</pre></div>
<p>The hypothetical commands ‘<samp>show w</samp>’ and ‘<samp>show c</samp>’ should show
the appropriate parts of the General Public License. Of course, the
commands you use may be called something other than ‘<samp>show w</samp>’ and
‘<samp>show c</samp>’; they could even be mouse-clicks or menu items—whatever
suits your program.
</p>
<p>You should also get your employer (if you work as a programmer) or your
school, if any, to sign a “copyright disclaimer” for the program, if
necessary. Here is a sample; alter the names:
</p>
<div class="example">
<pre class="example">Yoyodyne, Inc., hereby disclaims all copyright interest in the program
`Gnomovision' (which makes passes at compilers) written by James Hacker.
<var>signature of Ty Coon</var>, 1 April 1989
Ty Coon, President of Vice
</pre></div>
<p>This General Public License does not permit incorporating your program into
proprietary programs. If your program is a subroutine library, you may
consider it more useful to permit linking proprietary applications with the
library. If this is what you want to do, use the GNU Lesser General
Public License instead of this License.
</p>
<hr>
</body>
</html>
|