source: jclic/trunk/fuentes/dist/linux/man/jclic.1 @ 3466

Last change on this file since 3466 was 3466, checked in by Juanma, 4 years ago

Updated to 3.2.1

File size: 5.1 KB
Line 
1.\" Hey, EMACS: -*- nroff -*-
2.\" First parameter, NAME, should be all caps
3.\" Second parameter, SECTION, should be 1-8, maybe w/ subsection
4.\" other parameters are allowed: see man(7), man(1)
5.\" Please adjust this date whenever revising the manpage.
6.\"
7.\" Some roff macros, for reference:
8.\" .nh        disable hyphenation
9.\" .hy        enable hyphenation
10.\" .ad l      left justify
11.\" .ad b      justify to both left and right margins
12.\" .nf        disable filling
13.\" .fi        enable filling
14.\" .br        insert line break
15.\" .sp <n>    insert n+1 empty lines
16.\" for manpage-specific macros, see man(7)
17.TH "JClic Player" 1 2015-12-09 "" ""
18.SH NAME
19jclic \- Standalone player of multimedia educational activities
20.SH SYNOPSIS
21.B jclic
22.RI "[" OPTION "]... [" FILE "]"
23
24.SH DESCRIPTION
25This manual page describes briefly the
26.B jclic
27command.
28This manual page was written for the Debian GNU/Linux distribution.
29It only contains the description of the basic options.
30.br
31For full manuals and documentation please visit:
32.br
33http://clic.xtec.cat and http://projectestac.github.io/jclic
34
35.BR JClic
36is formed by a set of computer applications that are used for
37carrying out different types of educational activities: puzzles,
38associations, text exercises, crosswords...
39These activities are  packed in projects. A project is formed by a
40set of activities and one or more sequences, which indicate the order
41in which they have to be shown.
42
43.BR JClic
44is able to play JClic projects, that should have extension
45\fB*.jclic.zip\fP or \fB*.jclic\fP. It can also run installer macros
46of JClic projects, with extension \fB*.jclic.inst\fP and import
47packages of activities made with the old "Clic 3.0" software, that
48have extension \fB*.pcc\fP and \fB*.pac\fP.
49
50If you want to check about how JClic projects are, you should take a
51look at:
52.br
53http://clic.xtec.cat/db/listact_en.jsp
54
55.SH OPTIONS
56.TP 
57.B \-trace=true
58Show in a terminal some debug information for the application.
59.TP
60.BI \-language= code
61ISO 639 code of the language used by JClic in system messages and
62menus, e. g.: "pt" to indicate Portuguese.
63.TP
64.BI \-country= code
65Optional ISO 3166-1 code specifying a local variant of the language,
66e.g.: "BR" to indicate Brazilian Portuguese.
67.TP
68.BI \-variant= name
69An optional variable that can be used in conjunction with the
70preceding two, e.g.: "-language=ca -country=ES -variant=valencia" for
71the Valencian variant of Catalan.
72.TP
73.BI \-skin= name
74Type of visual interface used by JClic at start. The stock skins
75provided by JClic are:
76.I @default.xml @blue.xml @orange.xml @green.xml @simple.xml @mini.xml.
77Note that stock skin names are always preceeded by "@". Otherwise,
78you must indicate a full or relative path to an XML file implementing
79the JClic Skin Schema. For more info see:
80.br
81https://github.com/projectestac/jclic/blob/master/xml/skin.xsd
82.TP
83.BI \-systemSounds= true|false
84This option indicates if JClic must play or not system sounds.
85.TP
86.BI \-compressImages= true|false
87This option decides if JClic will compress images in order to make it
88to fit into the cells. Default is \fItrue\fP.
89.TP
90.BI \-lookAndFeel= value
91Java Look&Feel to be used by JClic. Possible values are
92.I default system metal motif
93and
94.I windows.
95Default is "system".
96.TP
97.BI \-audioEnabled= true|false
98This option allows to enable or disable the sounds in JClic.
99.TP
100.BI \-mediaSystem= JMF|QT
101Preferred multimedia system: "JMF" for Java Media Framework or "QT"
102for QuickTime.
103.TP
104.BI \-reporter=class
105Name of the Java class used by the reports engine of JClic, e.g.:
106"TCPReporter". Classes belonging to "edu.xtec.jclic.report" can
107safely ommit the package name.
108.TP
109.BI \-reporterParams= parameters
110Parameters passed to the reports engine. This option can have
111multiple key-value pairs inside, separated by semi-colons. E.g.:
112.br
113.B jclic -reporter=TCPReporter -reporterParams="path=localhost:9000/reports;user=john"
114.br
115The main parameters used by the stock reporter classes are:
116.SS "Main parameters used in the stock reporter classes"
117.TP
118.B user
119User id in the reports system.
120.TP
121.B key
122A special key that will be saved in the database. This kind of keys
123are used in the Moodle module of JClic to store session values.
124.TP
125.B context
126Another special key that will be saved in the database. It can
127indicate, for example, the type of course where the activities are
128being done.
129.TP
130.B path
131In TCPReporter only, complete path to the reports server, e.g.:
132"localhost:9000/reports"
133.TP
134.B protocol
135In TCPReporter only, protocol to be used to communicate with the
136reports server. Possible values are "http" and "https"
137(since JClic 0.2.2.0)
138.TP
139.B lap
140In TCPReporter, number of seconds between successive calls to the
141reports server. Default is 20 seconds.
142
143.SH AUTHORS
144JClic was written by Francesc Busquets <fbusquets@xtec.cat> for the
145Department of Education of the Government of Catalonia.
146.PP
147This manual page was initially written by José L. Redrejo Rodríguez
148<jredrejo@edu.juntaextremadura.net>, for the Debian project, and
149continued by Francesc Busquets <fbusquets@xtec.cat> (but may be
150used by others).
151
152.SH SEE ALSO
153.BR jclicauthor (1),
154.BR jclicreports (1),
155.BR jclic-libmanager (1)
156
Note: See TracBrowser for help on using the repository browser.