small irssistats localization patch
[irssistats] / irssistats.sgml
index 586cec1..bcde4cf 100644 (file)
@@ -78,7 +78,7 @@
     <para>Each option keyword is case sensitive, and you must put separators around the ':' character.</para>
     <para>Blank lines must not contain any spaces !</para>
     <para>Each option keeps its value until erased by another value.</para>
-    <para>IMPORTANT : the order of options to parse a channel must allways be "input" THEN "nickfile" THEN "output".</para>
+    <para>IMPORTANT : the order of options to parse a channel must allways be "input" THEN "nickfile" THEN "photofile" THEN "output".</para>
     
     <para>Available options are :</para>
     
         <term>language</term>
         <listitem>
           <para>Language you want to use to display the statistics</para>
-          <para>Values : fr en de du es it fi ru</para>
+          <para>Values : fr en de du es it fi ru et</para>
           <para>Default : en</para>
         </listitem>
       </varlistentry>
         </listitem>
       </varlistentry>
       
+      <varlistentry>
+        <term>weeks</term>
+        <listitem>
+          <para>Display last week statistics</para>
+          <para>Default : no</para>
+        </listitem>
+      </varlistentry>
+      
+      <varlistentry>
+        <term>months</term>
+        <listitem>
+          <para>Display last months statistics</para>
+          <para>Default : no</para>
+        </listitem>
+      </varlistentry>
+      
       <varlistentry>
         <term>refresh_time</term>
         <listitem>
         </listitem>
       </varlistentry>
       
+      <varlistentry>
+        <term>photo_size</term>
+        <listitem>
+          <para>Specifies the size in pixels of the thumbnails for users</para>
+          <para>This option has an effect only if there is a photofile (see below)</para>
+          <para>Set to 0 to disable (display pictures with their real size)</para>
+          <para>Default : 60</para>
+        </listitem>
+      </varlistentry>
+      
       <varlistentry>
         <term>w3c_link</term>
         <listitem>
         </listitem>
       </varlistentry>
       
+      <varlistentry>
+        <term>logo</term>
+        <listitem>
+          <para>Set this to "no" if you don't want the irssistats logo.</para>
+          <para>Default : yes</para>
+        </listitem>
+      </varlistentry>
+      
       <varlistentry>
         <term>header</term>
         <listitem><para>Use your custom header file (HTML code between &lt;!DOCTYPE... and &lt;body&gt; included)</para></listitem>
         </listitem>
       </varlistentry>
       
+      <varlistentry>
+        <term>photofile</term>
+        <listitem>
+          <para>This allow you to display pictures for users.</para>
+        </listitem>
+      </varlistentry>
+      
       <varlistentry>
         <term>output</term>
         <listitem>
   </refsect1>
   
   
+  <refsect1>
+    <title>PHOTOFILE</title>
+    <para>Since version 0.70 of <command>irssistats</command>, you can use a photofile to display pictures for users.</para>
+    <para>Each line of the photofile contains the final nick and an URL for the image.</para>
+    <para>Examples :</para>
+    <variablelist>
+      <varlistentry>
+        <term>royale http://royale.zerezo.com/chat/faces/happy40.png</term>
+        <listitem><para>(a full address)</para></listitem>
+      </varlistentry>
+      <varlistentry>
+        <term>sektor ../chat/faces/happy40.png</term>
+        <listitem><para>(a relative address)</para></listitem>
+      </varlistentry>
+    </variablelist>
+    <para>The photofile must not contain any comments.</para>
+    <para>You can also take a look at the "sample.photofile" in this package (in "/usr/share/doc/irssistats/").</para>
+  </refsect1>
+  
+  
   <refsect1>
     <title>SEE ALSO</title>
     <para><command>irssi</command> (1).</para>