PACONKY(1)							    PACONKY(1)



NAME
       paconky - display info about upgradable packages in conky


SYNOPSIS
       paconky [options] /path/to/config


DESCRIPTION
       Paconky	provides a convenient way to display information about upgrad‐
       able pacman packages in conky. It can display information  about	 pack‐
       ages in pacman's repositories and in the AUR. See below for information
       about how to set up paconky using configuration files.


OPTIONS
       --help <path>
	      Display the help message.


CONFIGURATION FILES
       A paconky configuration file is a simple text file containing tags that
       will be replaced with package info. It's best to start with an example:

	      New Repo Pkgs %PKG%

       If past a configuration file with the preceeding 2 lines, paconky would
       display "New Repo Pkgs" followed by a list of upgradable pkgs (one  per
       line...	see  %HORIZONTAL%  below  to change this). You could read this
       output in conky using one of the exec commands  to  display  the	 list.
       Because	paconky	 only replaces the tags, you could included conky for‐
       matting variables in the configuration file:

	      New Repo Pkgs $alignr %PKG%

       You could then use "execp" in Conky  and	 it  would  display  a	right-
       aligned	list  of  packages. One thing that's important to note here is
       the way paconky handles %PKG% and similar tags. The line itself will be
       repeated	 once  for each pkgs with each occurrence replaced by the pkg.
       Here's another example:

	      New Repo Pkgs %PKG_NAME% ${alignr}%PKG_VER%

       This time we would get a double-columned list with  pkg	names  in  the
       left column and pkg versions in the right column.

       We  also need to mention 2 special tags: %MSG% and %AUR_MSG% These will
       be replaced with a textual status message but most users will want this
       to  depend  on how many upgradable pkgs there are (in English anyway...
       your native language may have more or less cases). Example:

	      0 upgradable pkgs -> "up-to-date" 1 upgradable pkg -> "1 upgrad‐
	      able package" n (n>1) upgradable pkgs -> "n upgradable packages"

       To do this, you would add the following lines to the top of the config‐
       uration file:

	      #SET MSG_0 up-to-date #SET MSG_1 1 new package  #SET  MSG_N  %N%
	      new packages

       %MSG%  will now be replaced by the relevant line, depending on the num‐
       ber of packages. To do the same for  %AUR_MSG%,	you  would  add	 these
       lines:

	      #SET  AUR_MSG_0  up-to-date  #SET	 AUR_MSG_1  1 new package #SET
	      AUR_MSG_N %N% new packages

       All lines beginning with "#" are stripped from the final output.	 Blank
       lines are included to facilitate conky formatting.


TAGS
       %AUR_MSG%
	      A	 status	 message  that depends on the number of upgradable AUR
	      pkgs.

       %AUR_N%
	      The number of upgradable AUR pkgs.

       %AUR_PKG%
	      AUR pkg (name-ver): list

       %AUR_PKG_NAME%
	      AUR pkg name: list

       %AUR_PKG_VER%
	      AUR pkg version: list

       %HORIZONTAL%
	      This  suppresses	the  trailing  newline	for  each  line.  When
	      included	on  a  line which would normally repeat across several
	      lines, it will cause it to repeat on one instead. The tag itself
	      will be completely removed.

       %MSG%  A	 status	 message that depends on the number of upgradable repo
	      pkgs. See above more more information.

       %N%    The number of upgradable repo pkgs.

       %PKG%  Repo pkg (name-ver): list

       %PKG_NAME%
	      Repo pkg name: list

       %PKG_REPO%
	      Name of repo which contains the pkg: list

       %PKG_VER%
	      Repo pkg version: list


AUTHORS
       Xyne



				  March 2009			    PACONKY(1)