summaryrefslogtreecommitdiffstats
path: root/upstream/archlinux/man3/libalpm_misc.3
blob: 0727e693eaaf871309331bfef5019049dd4d9716 (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
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
.TH "libalpm_misc" 3 "libalpm" \" -*- nroff -*-
.ad l
.nh
.SH NAME
libalpm_misc \- Miscellaneous Functions
.SH SYNOPSIS
.br
.PP
.SS "Typedefs"

.in +1c
.ti -1c
.RI "typedef int64_t \fBalpm_time_t\fP"
.br
.RI "The time type used by libalpm\&. "
.in -1c
.SS "Enumerations"

.in +1c
.ti -1c
.RI "enum \fBalpm_caps\fP { \fBALPM_CAPABILITY_NLS\fP = (1 << 0), \fBALPM_CAPABILITY_DOWNLOADER\fP = (1 << 1), \fBALPM_CAPABILITY_SIGNATURES\fP = (1 << 2) }"
.br
.RI "Enum of possible compile time features\&. "
.in -1c
.SS "Functions"

.in +1c
.ti -1c
.RI "\fBalpm_pkg_t\fP * \fBalpm_sync_get_new_version\fP (\fBalpm_pkg_t\fP *pkg, \fBalpm_list_t\fP *dbs_sync)"
.br
.RI "Check for new version of pkg in syncdbs\&. "
.ti -1c
.RI "char * \fBalpm_compute_md5sum\fP (const char *filename)"
.br
.RI "Get the md5 sum of file\&. "
.ti -1c
.RI "char * \fBalpm_compute_sha256sum\fP (const char *filename)"
.br
.RI "Get the sha256 sum of file\&. "
.ti -1c
.RI "int \fBalpm_unlock\fP (\fBalpm_handle_t\fP *handle)"
.br
.RI "Remove the database lock file\&. "
.ti -1c
.RI "const char * \fBalpm_version\fP (void)"
.br
.RI "Get the version of library\&. "
.ti -1c
.RI "int \fBalpm_capabilities\fP (void)"
.br
.RI "Get the capabilities of the library\&. "
.in -1c
.SH "Detailed Description"
.PP 


Various libalpm functions 
.SH "Typedef Documentation"
.PP 
.SS "typedef int64_t \fBalpm_time_t\fP"

.PP
The time type used by libalpm\&. Represents a unix time stamp 
.SH "Enumeration Type Documentation"
.PP 
.SS "enum \fBalpm_caps\fP"

.PP
Enum of possible compile time features\&. 
.PP
\fBEnumerator\fP
.in +1c
.TP
\fB\fIALPM_CAPABILITY_NLS \fP\fP
localization 
.TP
\fB\fIALPM_CAPABILITY_DOWNLOADER \fP\fP
Ability to download\&. 
.TP
\fB\fIALPM_CAPABILITY_SIGNATURES \fP\fP
Signature checking\&. 
.SH "Function Documentation"
.PP 
.SS "int alpm_capabilities (void)"

.PP
Get the capabilities of the library\&. 
.PP
\fBReturns\fP
.RS 4
a bitmask of the capabilities 
.RE
.PP

.SS "char * alpm_compute_md5sum (const char * filename)"

.PP
Get the md5 sum of file\&. 
.PP
\fBParameters\fP
.RS 4
\fIfilename\fP name of the file 
.RE
.PP
\fBReturns\fP
.RS 4
the checksum on success, NULL on error 
.RE
.PP

.SS "char * alpm_compute_sha256sum (const char * filename)"

.PP
Get the sha256 sum of file\&. 
.PP
\fBParameters\fP
.RS 4
\fIfilename\fP name of the file 
.RE
.PP
\fBReturns\fP
.RS 4
the checksum on success, NULL on error 
.RE
.PP

.SS "\fBalpm_pkg_t\fP * alpm_sync_get_new_version (\fBalpm_pkg_t\fP * pkg, \fBalpm_list_t\fP * dbs_sync)"

.PP
Check for new version of pkg in syncdbs\&. If the same package appears multiple dbs only the first will be checked
.PP
This only checks the syncdb for a newer version\&. It does not access the network at all\&. See \fBalpm_db_update\fP to update a database\&. 
.SS "int alpm_unlock (\fBalpm_handle_t\fP * handle)"

.PP
Remove the database lock file\&. 
.PP
\fBParameters\fP
.RS 4
\fIhandle\fP the context handle 
.RE
.PP
\fBReturns\fP
.RS 4
0 on success, -1 on error
.RE
.PP
\fBNote\fP
.RS 4
Safe to call from inside signal handlers\&. 
.RE
.PP

.SS "const char * alpm_version (void)"

.PP
Get the version of library\&. 
.PP
\fBReturns\fP
.RS 4
the library version, e\&.g\&. '6\&.0\&.4' 
.RE
.PP

.SH "Author"
.PP 
Generated automatically by Doxygen for libalpm from the source code\&.