APT-FTPARCHIVE(1)                     APT                    APT-FTPARCHIVE(1)

NOMBRE
       apt-ftparchive - Herramienta para generar ficheros de indice

SINOPSIS
       apt-ftparchive [-dsq] [--md5] [--delink] [--readonly] [--contents]
                      [--arch architecture] [-o=config_string]
                      [-c=config_file]
                      {packages path [override-file [pathprefix]]  |
                      sources path [override-file [pathprefix]]  |
                      contents path  | release path  |
                      generate config_file section...  | clean config_file  |
                      {-v | --version} | {-h | --help}}

DESCRIPCION
       apt-ftparchive es la herramienta de la linea de ordenes que genera los
       ficheros de indice que APT utiliza para acceder a la fuente de la
       distribucion. Los ficheros de indice se deberian generar en el sitio de
       origen basado en el contenido de ese sitio.

       apt-ftparchive es un superconjunto del programa dpkg-scanpackages(1), e
       incorpora su funcionalidad al completo mediante la orden packages.
       Tambien contiene un generador de contenidos de fichero, contents, y un
       modo elaborado para realizar un <<script>> para el proceso de
       generacion de un archivo completo.

       Internamente, apt-ftparchive puede hacer uso de bases de datos binarias
       para almacenar los contenidos de un fichero <<.deb>> y no depender de
       ningun programa externo como gzip(1). Cuando se realiza una generacion
       completa, automaticamente realiza comprobaciones de cambios en los
       ficheros y genera los ficheros de salida comprimidos deseados.

       A menos que se use la opcion -h o --help, una de las siguientes ordenes
       debe estar presente.

       packages
           La orden <<packages>> genera un fichero de paquete a partir de un
           directorio. Busca recursivamente ficheros <<.deb>> en el directorio
           proporcionado, generando un registro de paquete en la salida
           estandar para cada uno. Esta orden es casi un equivalente de dpkg-
           scanpackages(1).

           La opcion --db se puede usar para especificar una base de datos
           binaria para la cache (registro de paquetes).

       sources
           La orden sources genera un fichero de indice de fuentes a partir de
           un directorio. Toma el directorio proporcionado y busca en el
           recursivamente ficheros <<.dsc>>, generando un registro de fuente
           en la salida estandar para cada uno. Esta orden es casi un
           equivalente de dpkg-scansources(1).

           Si se define un fichero alternativo, se buscara un fichero de
           fuentes alternativo con la extension <<.src>>. Puede usar la opcion
           --source-override para cambiar el fichero de fuentes alternativo
           que se usara.

       contents
           La orden contents genera un fichero de contenidos a partir de un
           directorio. Toma el directorio proporcionado y busca en el
           recursivamente ficheros <<.deb>>, lee la lista de ficheros para
           cada uno, los ordena y muestra en la salida estandar la lista de
           ficheros que coinciden con los paquetes. Los directorios no se
           muestran por la salida estandar. Si varios paquetes tienen el mismo
           fichero, entonces cada paquete se separara por una coma en la
           salida.

           La opcion --db se puede usar para especificar una base de datos
           binaria para la cache (registro de paquetes).

       release
           The release command generates a Release file from a directory tree.
           It recursively searches the given directory for uncompressed and
           compressed Packages, Sources, Contents, Components and icons files
           as well as Release, Index and md5sum.txt files by default
           (APT::FTPArchive::Release::Default-Patterns). Additional filename
           patterns can be added by listing them in
           APT::FTPArchive::Release::Patterns. It then writes to stdout a
           Release file containing (by default) an MD5, SHA1, SHA256 and
           SHA512 digest for each file.

           Los valores para los campos de metadatos adicionales en el fichero
           <<Release>> se toman de las variables correspondientes en
           APT::FTPArchive::Release, por ejemplo
           APT::FTPArchive::Release::Origin. Los campos permitidos son:
           Origin, Label, Suite, Version, Codename, Date, NotAutomatic,
           ButAutomaticUpgrades, Acquire-By-Hash, Valid-Until, Signed-By,
           Architectures, Components y Description.

       generate
           La orden generate se ha disenado para ejecutarse desde un script de
           cron y genera los indices de acuerdo a lo proporcionado en el
           fichero de configuracion. El lenguaje de configuracion proporciona
           una forma flexible de definir que ficheros de indice se generaran a
           partir de que directorios, asi como proporcionar una forma sencilla
           de mantener la configuracion necesaria.

       clean
           La orden clean ordena las bases de datos que usa el fichero de
           configuracion proporcionado, eliminando los registros que no son
           necesarios.

LA CONFIGURACION DE <<GENERATE>>
       La orden generate usa un fichero de configuracion para describir los
       ficheros que se generaran. Sigue el tipico formato de configuracion de
       ISC presente en las herramientas de ISC como bind 8 y dhcpd.
       apt.conf(5) contiene una descripcion de la sintaxis. Tenga en cuenta
       que la configuracion de <<generate>> se analiza por seccion, pero
       apt.conf(5) se analiza por arbol. Esto solo afecta a como se maneja el
       ambito de la etiqueta.

       La configuracion de <<generate>> tiene cuatro secciones diferentes,
       descritas a continuacion.

   Seccion Dir
       La seccion Dir define los directorios estandar necesarios para ubicar
       los ficheros necesarios durante el proceso de generacion. A estos
       directorios se les anaden ciertas rutas relativas definidas en
       secciones posteriores para producir una ruta absoluta.

       ArchiveDir
           Define la raiz del archivo FTP; en una configuracion estandar de
           Debian este es el directorio que contiene el ls-LR y los nodos
           <<dist>>.

       OverrideDir
           Define la ubicacion de los ficheros alternativos.

       CacheDir
           Define la ubicacion de los ficheros almacenados.

       FileListDir
           Define la ubicacion de los ficheros del listado de ficheros, si se
           usa posteriormente el valor FileList.

   Seccion Default
       La seccion Default define los valores predeterminados, y los ajustes
       que controlan la operacion del generador. Otras secciones pueden
       sobrescribir estos valores predeterminados con un valor de la seccion.

       Packages::Compress
           Sets the default compression schemes to use for the package index
           files. It is a string that contains a space separated list of at
           least one of the compressors configured via the APT::Compressor
           configuration scope. The default for all compression schemes is '.
           gzip'.

       Packages::Extensions
           Define la lista predeterminada de extensiones de fichero que son
           ficheros de paquete. El valor predeterminado es <<.deb>>.

       Sources::Compress
           Esta opcion es similar a Packages::Compress excepto que controla la
           compresion para los ficheros <<Sources>>.

       Sources::Extensions
           Define la lista predeterminada de las extensiones de fichero que
           son ficheros de fuentes. El valor predeterminado es <<.dsc>>.

       Contents::Compress
           Esta opcion es similar a Packages::Compress excepto que controla la
           compresion para los ficheros <<Contents>>.

       Translation::Compress
           Esta opcion es similar a Packages::Compress excepto que controla la
           compresion para el fichero maestro Translation-en.

       DeLinkLimit
           Define el numero de kilobytes a desenlazar (y reemplazar con
           enlaces duros) por ejecucion. Se usa junto al valor External-Links
           de cada seccion.

       FileMode
           Define el modo de todos los ficheros de indice creados. El valor
           predeterminado es 0644. Todos los ficheros de indice se ajustan a
           este modo sin tener en cuenta la mascara de usuario (<<umask>>).

       LongDescription
           Define si se incluyen descripciones largas en el fichero Packages,
           o si se separan en un fichero Translation-en maestro.

   Seccion TreeDefault
       Define los valores predeterminados de las secciones Tree. Todas estas
       variables son variables de sustitucion y reemplazan las cadenas
       $(DIST), $(SECTION) y $(ARCH) con sus valores respectivos.

       MaxContentsChange
           Define el numero de kilobytes de los ficheros de contenido que se
           generan cada dia. Los ficheros de contenido estan en una cola
           <<round-robin>>, de modo que durante varios dias todos se
           regeneraran.

       ContentsAge
           Controla el numero de dias en los que se permite comprobar un
           fichero de contenido sin cambios. Si este limite caduca, el tiempo
           de modificacion (mtime) del fichero de contenido se actualiza. Este
           caso puede aparecer si un fichero de paquete cambia de forma que no
           resulte en un fichero de contenido nuevo (por ejemplo, una edicion
           alternativa). Se permite la retencion con la esperanza de que se
           instalen nuevos <<.deb>>, lo cual precisa un fichero nuevo de todos
           modos. El valor predeterminado es diez, las unidades usadas son
           dias.

       Directory
           Define la raiz del directorio <<.deb>>. El valor predeterminado es
           $(DIST)/$(SECTION)/binary-$(ARCH)/

       SrcDirectory
           Define la raiz del directorio de los paquetes de fuentes. El valor
           predeterminado es $(DIST)/$(SECTION)/source/

       Packages
           Define el fichero <<Packages>> de salida. El valor predeterminado
           es $(DIST)/$(SECTION)/binary-$(ARCH)/Packages

       Sources
           Define el fichero <<Sources>> de salida. El valor predeterminado es
           $(DIST)/$(SECTION)/source/Sources

       Translation
           Define el fichero maestro <<Translation-en>> que contiene las
           descripciones largas en el caso de que no se incluyan en el fichero
           <<Packages>>. El valor predeterminado es
           $(DIST)/$(SECTION)/i18n/Translation-en

       InternalPrefix
           Define el prefijo de la ruta que hace que un enlace simbolico se
           considere un enlace interno en lugar de un enlace externo. El valor
           predeterminado es $(DIST)/$(SECTION)/

       Contents
           Define el fichero <<Contents>> de salida. El valor predeterminado
           es $(DIST)/Contents-$(ARCH). Si este valor provoca que varios
           ficheros <<Packages>> se relacionen con un unico fichero
           <<Contents>> (el comportamiento predeterminado), apt-ftparchive
           integrara automaticamente esos ficheros de paquete.

       Contents::Header
           Define el fichero de cabecera a anadir al fichero <<Contents>> de
           salida.

       BinCacheDB
           Define la base de datos binaria de la cache para usar en esta
           seccion. Varias secciones pueden compartir la misma base de datos.

       FileList
           Define que apt-ftparchive deberia leer la lista de ficheros del
           fichero proporcionado en lugar de explorar recursivamente el arbol
           de directorios. A los nombres de los ficheros relativos se les
           anade como prefijo el directorio del archivo.

       SourceFileList
           Define que apt-ftparchive deberia leer la lista de ficheros del
           fichero proporcionado en lugar de explorar recursivamente el arbol
           de directorio. A los nombres de los ficheros relativos se les anade
           como prefijo el directorio del archivo. Solo se usa cuando se
           procesan indices de fuentes.

   Seccion Tree
       La seccion Tree define un arbol de un archivo de paquetes Debian
       estandar que consiste en un directorio base, varias secciones en ese
       directorio base y finalmente varias arquitecturas en cada seccion. La
       ruta exacta usada se define en la variable de sustitucion Directory.

       La seccion Tree toma un ambito de una etiqueta que define la variable
       $(DIST) y la raiz del arbol (a la ruta se le anade el prefijo
       ArchiveDir). Normalmente esto es un valor como dists/bookworm.

       Todos los valores definidos en la seccion TreeDefault se pueden
       utilizar en la seccion Tree, asi como tres nuevas variables.

       Cuando se procesa una seccion Tree apt-ftparchive realiza una operacion
       similar a la siguiente:

           for i in Sections do
              for j in Architectures do
                 Generar con DIST=scope SECTION=i ARCH=j



       Sections
           Es una lista de secciones separadas por espacios que aparecen bajo
           la distribucion; habitualmente, es similar a main contrib non-free
           non-free-firmware.

       Architectures
           This is a space separated list of all the architectures that appear
           under search section. The special architecture 'source' is used to
           indicate that this tree has a source archive. The architecture
           'all' signals that architecture specific files like Packages should
           not include information about architecture all packages in all
           files as they will be available in a dedicated file.

       LongDescription
           Define si se incluyen descripciones largas en el fichero Packages,
           o si se separan en un fichero Translation-en maestro.

       BinOverride
           Define el fichero binario alternativo. Este contiene la informacion
           sobre la seccion, la prioridad y la direccion del mantenedor.

       SrcOverride
           Define el fichero de fuentes alternativo. Este contiene la
           informacion sobre la seccion.

       ExtraOverride
           Define el fichero binario alternativo adicional.

       SrcExtraOverride
           Define el fichero de fuentes alternativo adicional.

   Seccion BinDirectory
       La seccion bindirectory define un directorio binario sin ningun tipo de
       estructura especial. El ambito de la etiqueta define la ubicacion del
       directorio binario, la configuracion es similar a la seccion Tree sin
       sustituir las variables o la configuracion de SectionArchitecture.

       Packages
           Define el fichero <<Packages>> de salida.

       Sources
           Define el fichero <<Sources>> de salida. Es necesario al menos un
           fichero Packages o Sources.

       Contents
           Define el fichero <<Contents>> de salida (opcional)

       BinOverride
           Define el fichero binario alternativo.

       SrcOverride
           Define el fichero de fuentes alternativo.

       ExtraOverride
           Define el fichero binario alternativo adicional.

       SrcExtraOverride
           Define el fichero de fuentes alternativo adicional.

       BinCacheDB
           Define la base de datos de la cache.

       PathPrefix
           Anade una ruta a todas las rutas de salida.

       FileList, SourceFileList
           Define el fichero de la lista de ficheros.

EL FICHERO BINARIO ALTERNATIVO
       El fichero binario alternativo es totalmente compatible con dpkg-
       scanpackages(1). Contiene cuatro campos separados por espacios. El
       primero es el nombre del paquete, el segundo la prioridad asignada el
       paquete, el tercero es la seccion a la que se fuerza el paquete y el
       ultimo es el campo de permutacion del mantenedor.

       La forma general del campo del mantenedor es:

           antigua [// antigua-n]* => nueva

       o simplemente

           nueva

       La primera forma permite una lista separada por barras dobles de las
       direcciones de correo electronico antiguas a definir. Si se encuentra
       cualquier de ellas <<nueva>> se sustituye por el campo del mantenedor.
       La segunda forma sustituye de forma incondicional el campo del
       mantenedor.

EL FICHERO DE FUENTES ALTERNATIVO
       El fichero de fuentes alternativo es totalmente compatible con dpkg-
       scansources(1). Contiene dos campos separados por espacios. El primero
       es el nombre del paquete fuente, el segundo es la seccion a la que se
       asignara.

EL FICHERO ALTERNATIVO ADICIONAL
       El fichero alternativo adicional permite anadir o reemplazar en la
       salida cualquier etiqueta arbitraria. Tiene tres columnas, la primera
       es el paquete, la segunda es la etiqueta y el resto de la linea es el
       nuevo valor.

OPCIONES
       Todas las opciones de la linea de ordenes se pueden definir mediante el
       fichero de configuracion, las descripciones indican la opcion de la
       configuracion a definir. Para opciones de tipo <<boolean>> puede
       invalidar el fichero de configuracion utilizando algo como -f-,--no-f,
       -f=no u otras muchas variaciones.

       --md5, --sha1, --sha256, --sha512
           Genera la suma de control dada. Por omision, estas opciones estan
           activas. Si se desactivan, los ficheros de indice generados no
           contendran los campos de suma de control donde sea posibl. Opciones
           de configuracion: APT::FTPArchive::Checksum y
           APT::FTPArchive::Index::Checksum donde Index puede ser Packages,
           Sources o Release, y Checksum puede ser MD5, SHA1, SHA256 o SHA512.

       -d, --db
           Utiliza una base de datos binaria para la cache. Esto no afecta a
           la orden <<generate>>. Opcion de configuracion:
           APT::FTPArchive::DB.

       -q, --quiet
           Silencioso, produce una salida adecuada para su almacenamiento,
           omitiendo los indicadores de progreso. Mas letras <<q>> producen
           una salida mas silenciosa, hasta un maximo de dos letras. Ademas,
           es posible usar -q=# para ajustar el nivel de silencio, ignorando
           el fichero de configuracion. Opcion de configuracion: quiet.

       --delink
           Realiza el desenlazado. Esta opcion activa el desenlazado de los
           ficheros si se usa la opcion External-Links. Esta activa de forma
           predeterminada y se puede desactivar mediante --no-delink. Opcion
           de configuracion: APT::FTPArchive::DeLinkAct.

       --contents
           Realiza la generacion de <<contents>>. Cuando se usa esta opcion y
           los indices de los paquetes se estan generando con una base de
           datos de la cache, el listado de los ficheros se extraera tambien y
           se almacenara en la base de datos para su uso posterior. Cuando se
           usa la orden <<generate>> esta opcion tambien permite la creacion
           de cualquier fichero <<Contents>>. Esta activa de forma
           predeterminada. Opcion de configuracion: APT::FTPArchive::Contents.

       -s, --source-override
           Selecciona el fichero de fuentes alternativo a usar con la orden
           sources. Opcion de configuracion: APT::FTPArchive::SourceOverride.

       --readonly
           Define los permisos de las bases de datos de la cache como solo
           lectura. Opcion de configuracion: APT::FTPArchive::ReadOnlyDB.

       -a, --arch
           Hace que las ordenes packages y contents solo acepten aquellos
           paquetes que coinciden con *_arch.deb o *_all.deb, en lugar de
           todos los ficheros de paquete en la ruta dada. Elemento de
           configuracion: APT::FTPArchive::Architecture.

       APT::FTPArchive::AlwaysStat
           apt-ftparchive(1) almacena tantos metadatos como sea posible en una
           base de datos de almacenamiento. Si los paquetes se recompilan o
           publican otra vez con la misma version apareceran problemas ya que
           se usaran los metadatos almacenados y ahora obsoletos tales como el
           tamano o la suma de control. Esta situacion se evitara si se activa
           esta opcion ya que se comprobara si el fichero ha cambiado. Tenga
           en cuenta que esta opcion esta definida como <<false>> por omision,
           ya que no se recomienda subir varias versiones o compilaciones de
           un paquete con el mismo numero de version, asi que en teoria nadie
           deberia tener problemas y por ello todas estas comprobaciones
           adicionales son innecesarias.

       APT::FTPArchive::LongDescription
           De forma predeterminada esta opcion de configuracion se define como
           <<true>> y solo se deberia definir como <<false>> si el archivo de
           paquetes generado con apt-ftparchive(1) tambien proporciona
           ficheros Translation. Tenga en cuenta que el fichero maestro
           Translation-en solo se puede crear con la orden <<generate>>.

       -h, --help
           Muestra un mensaje corto sobre el uso.

       -v, --version
           Muestra la version del programa.

       --audit
           Show audit (and notice) messages. This overrides the quiet option,
           but only for notice messages, not progress ones.

       -c, --config-file
           Fichero de configuracion: Especifica el fichero de configuracion a
           usar. El programa leera el fichero de configuracion predeterminado
           y, despues, este fichero de configuracion. Si necesita que ciertas
           opciones de configuracion se definan antes que el analisis de los
           de los ficheros de configuracion predeterminados, defina un fichero
           con la variable de entorno APT_CONFIG. Consulte apt.conf(5) para
           informacion sobre la sintaxis.

       -o, --option
           Set a Configuration Option; This will set an arbitrary
           configuration option. The syntax is -o Foo::Bar=bar.  -o and
           --option can be used multiple times to set different options.

       --no-color, --color
           Turn colors on or off. Colors are on by default on supported
           terminals for apt(8) and can also be disabled using the NO_COLOR or
           APT_NO_COLOR environment variables, or further configured by the
           APT::Color configuration option and scope, see apt.conf(5) for
           information on that.

EJEMPLOS
       Para crear un fichero <<Packages>> comprimido para un directorio que
       contenga paquetes binarios (<<.deb>>):

           apt-ftparchive packages directorio | gzip > Packages.gz

VEASE TAMBIEN
       apt.conf(5)

DIAGNOSTICOS
       apt-ftparchive devuelve cero si no hay ningun error, y el valor 100 en
       caso de error.

BUGS
       Pagina de errores de APT[1]. Si quiere informar de un error en APT,
       consulte /usr/share/doc/debian/bug-reporting.txt o use la orden
       reportbug(1).

TRADUCCION
       La traduccion al espanol la realizaron Ismael Fanlo, Carlos Mestre,
       Rudy Godoy, Gustavo Saldumbide, Javier Fernandez-Sanguino y Ruben
       Porras Campo entre los anos 2003 y 2004. La traduccion fue actualizada
       por Francisco Javier Cuadrado y Omar Campagne Polaino entre los anos
       2009 y 2012 .

       Tenga en cuenta que este documento puede contener secciones sin
       traducir. Esto es intencionado para evitar perder contenido cuando la
       traduccion no esta actualizada con respecto al documento original.

AUTORES
       Jason Gunthorpe

       Equipo de APT

NOTAS
        1. Pagina de errores de APT
           https://bugs.debian.org/src:apt

APT 2.9.6                        29 Enero 2023               APT-FTPARCHIVE(1)