.\" Man page generated from reStructuredText.
.
.TH "CDIST-TYPE__PACKAGE_UPDATE_INDEX" "7" "Feb 16, 2019" "4.10.6" "cdist"
.
.nr rst2man-indent-level 0
.
.de1 rstReportMargin
\\$1 \\n[an-margin]
level \\n[rst2man-indent-level]
level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
-
\\n[rst2man-indent0]
\\n[rst2man-indent1]
\\n[rst2man-indent2]
..
.de1 INDENT
.\" .rstReportMargin pre:
. RS \\$1
. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin]
. nr rst2man-indent-level +1
.\" .rstReportMargin post:
..
.de UNINDENT
. RE
.\" indent \\n[an-margin]
.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]]
.nr rst2man-indent-level -1
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
..
.SH NAME
.sp
cdist\-type__update_index \- Update the package index
.SH DESCRIPTION
.sp
This cdist type allows you to update the package index on the target.
It will automatically use the appropriate package manager.
.SH REQUIRED PARAMETERS
.sp
None
.SH OPTIONAL PARAMETERS
.INDENT 0.0
.TP
.B type
The package manager to use. Default is determined based on the $os
explorer variable.
e.g.
* apt for Debian
* yum for Red Hat
* pacman for Arch Linux
.TP
.B maxage
Available for package manager apt and pacman, max time in seconds since
last update. Repo update is skipped if maxage is not reached yet.
.UNINDENT
.SH MESSAGES
.INDENT 0.0
.TP
.B apt\-cache updated (age was: currage)
apt\-cache was updated (run of \fIapt\-get update\fP). \fIcurrage\fP is the time
in seconds since the previous run.
.UNINDENT
.SH EXAMPLES
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
# Update the package index on the target
__package_update_index

# Force use of a specific package manager
__package_update_index \-\-type apt

# Only update every hour:
__package_update_index \-\-maxage 3600 \-\-type apt

# same as above (on apt\-type systems):
__package_update_index \-\-maxage 3600
.ft P
.fi
.UNINDENT
.UNINDENT
.SH AUTHORS
.nf
Ricardo Catalinas Jiménez <\fI\%jimenezrick\-\-@\-\-gmail.com\fP>
Thomas Eckert <\fI\%tom\-\-@\-\-it\-eckert.de\fP>
Stu Zhao <\fI\%z12y12l12\-\-@\-\-gmail.com\fP>
.fi
.sp
.SH COPYING
.sp
Copyright (C) 2014 Ricardo Catalinas Jiménez. 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 3 of the
License, or (at your option) any later version.
.\" Generated by docutils manpage writer.
.