summaryrefslogtreecommitdiff
path: root/debian/man/installmgr.1.pod
blob: 244e8ba45f7ed22afcac4a4db8b60be99d0fdb3e (plain)
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
#  This is manual page in Perl POD format. Read more at
#  http://perldoc.perl.org/perlpod.html or run command:
#
#     perldoc perlpod | less
#
#  To check the syntax:
#
#     podchecker *.pod
#
#  Create manual page with command:
#
#    pod2man PAGE.N.pod > PAGE.N

=head1 NAME

installmgr - install, list, update and remove SWORD modules

=head1 SYNOPSIS

B<installmgr> -init

B<installmgr> -l

B<installmgr> -u [ModuleName]

B<installmgr> -s

B<installmgr> [-r | -rl | -rd] [RemoteSrcName]

B<installmgr> -ri [RemoteSrcName] [ModuleName]

B<installmgr> -ll [PATH]

B<installmgr> -li [PATH] [ModuleName]

=head1 DESCRIPTION

A command line utility to manipulate SWORD modules. It can be used to install,
remove, list and update SWORD modules, from local and network locations.

Please note modules will be installed into /usr/share/sword without using
APT. If you use this utility you will not be able to uninstall these modules
using apt-get, aptitude, synaptic and similar tools.  

=head1 OPTIONS

=over

=item B<-init>

Creates basic user configuration file. This will overwrite existing one.

=item B<-l>

Lists currently installed SWORD modules.

=item B<-u [ModuleName]>

Uninstalls module.

=item B<-s>

Lists available remote sources

=item B<[-r | -rl | -rd] [RemoteSrcName]>

These are used to manipulate remote sources.

=over

=item -r

Refreshes remote source.

=item -rl

Lists available modules from the remote source.

=item -rd

Lists new/updated modules from the remote source.

=back

=item B<-ri [RemoteSrcName] [ModuleName]>

Install module from remote source.

=item B<-ll [PATH]>

List available modules at a specified local path.

=item B<-li [PATH] [ModuleName]>

Install module from local path.

=back

=head1 Authors

This manual page was written by Dmitrijs Ledkovs <dmitrij.ledkov@gmail.com> for
Debian project but may be used by others.

=head1 SEE ALSO

=cut