Skip to content

12.icon.md

Latest commit

 

History

History
71 lines (61 loc) · 3.99 KB

12.icon.md

File metadata and controls

71 lines (61 loc) · 3.99 KB
icon image
description Fetch Icon/Logo file from Remote/Local (SBUILD) Source (TYPE: NON_ENFORCED)

12.Icon

{% code overflow="wrap" %}

#Example ONLY
icon:
 #Can contain one of (or all of): url, file, dir
 #If it contains multiple (or all), the builder WILL STOP UPON FIRST successful Icon/Log file MATCH (Tries PNG, else SVG)
  url: "#A Direct RAW URL to download a icon/logo file"
  file: "#A Direct PATH to a icon/logo file from ${SBUILD_OUTDIR} | ${SBUILD_TMPDIR}"
  dir: "#A Direct PATH to a Directory that contains at least 1 icon/logo"

{% endcode %}

  • This is Optional & can be left empty or removed completely (TYPE:NON_ENFORCED)
  • Only One entry is supported
  • If $pkg_type is a binary format, then this is used only for soarquery/info
  • If $pkg_type is a package format like AppImage, FlatImage, then it is downloaded & saved as .DirIcon as ${SBUILD_OUTDIR}/.DirIcon
  • If used, it can only contain (One of these or all):
  • url : Is always preferred as the 1st Choice, even if used with others
  • file : Is ONLY preferred, if url was non-existent/empty, as the 2nd Choice
  • dir : Is ONLY preferred, if both url & file are non-existent/empty, as the 3rd & Final Choice

{% code overflow="wrap" %}

#Another Example
icon:
 #Can contain one of (or all of): url, file, dir
  url: "https://example.com/example.png"
  #If you only use `/example.png` or `example.png`, it is assumed as: ${SBUILD_OUTDIR}/example.png
  #Here, we specify explictly to use ${SBUILD_TMPDIR}
  file: "${SBUILD_TMPDIR}/example.png" 
  #You can just use `/usr/share` or `usr/share`, it is assumed as: ${SBUILD_OUTDIR}/usr/share
  dir: "usr/share" #will search in ${SBUILD_OUTDIR}/usr/share

{% endcode %}

{% hint style="info" %} file supports wildcard glob (*) pattern

{% code overflow="wrap" %}

icon:
#Will search for a *.png file in ${SBUILD_TMPDIR} (picks first match)
  file: "${SBUILD_TMPDIR}/*.png"

{% endcode %} {% endhint %}

{% hint style="info" %} dir supports wildcard glob (*) pattern

icon:
  dir: "${SBUILD_OUTDIR}/usr/share/applications/icons*" 
#Will search inside all these dir (picks first png, else first svg):
# ${SBUILD_OUTDIR}/usr/share/applications/icons128
# ${SBUILD_OUTDIR}/usr/share/applications/icons256
# ${SBUILD_OUTDIR}/usr/share/applications/iconsXYZ

{% endhint %}

{% hint style="info" %}

  • This MAY BE OVERWRITTEN, if x_exec.run does something to the file (example: It produces it's own ${SBUILD_PKG}.{png|svg} file), otherwise is used as the default .DirIcon & ${SBUILD_OUTDIR}/${SBUILD_PKG}.png file
  • The icon file is renamed to ${SBUILD_OUTDIR}/${SBUILD_PKG}.{png|svg}based on the ImageType {% endhint %}