Difference between revisions of "Hylafax Notes"

From OpenEMR Project Wiki
 
(44 intermediate revisions by the same user not shown)
Line 2: Line 2:
''(All examples in this section are using Linux/Ubuntu.)''
''(All examples in this section are using Linux/Ubuntu.)''
*[http://www.hylafax.org/content/Main_Page Hylafax Website]
*[http://www.hylafax.org/content/Main_Page Hylafax Website]
::*[http://www.hylafax.org/content/Handbook Hylafax Handbook]
::*[http://www.hylafax.org/man/6.0.6/ Hylafax Man Pages for Commands]
:::*[http://www.hylafax.org/man/6.0.6/hylafax-config.4f.html Hylafax-Config]
:::*[http://www.hylafax.org/man/6.0.6/faxstat.1.html Faxstat]
*[http://hylafax.sourceforge.net Hylafax Plus Website]
*[http://hylafax.sourceforge.net Hylafax Plus Website]
*[http://www.aboutdebian.com/fax.htm About Debian Linux - Linux FAX Server]
<br>
'''Wiki Notes:'''
*[[Modem Applications]]
*[[FAX Modem Troubleshooting Notes]]
*[[FAX Modem Troubleshooting Notes]]
<br>
<br>
==Install Hylafax==
==Install Hylafax==
sudo apt-get install hylafax-server hylafax-client
<pre style="font-size: 130%; margin: 1em 2em 1em 2em;">
sudo apt-get install hylafax-server hylafax-client
sudo gpasswd -a [USERNAME] dialout
sudo chmod a+x /usr/sbin/pppd
</pre>
 


<br>


==Start and Stop Hylafax==
<pre style="font-size: 130%; margin: 1em 2em 1em 2em;">
sudo /etc/init.d/hylafax stop
sudo /etc/init.d/hylafax start
</pre>


<br>
==Configuration==
*General Configuration
::/etc/hylafax/hfaxd.conf
::Unrestrict Faxes So Other Users Can Access Them
<pre style="font-size: 130%; margin: 1em 2em 1em 2em;">
JobProtection:  0644
PublicJobQ:      true
PublicRecvQ:    true
</pre>
<br>


*Modem Configuration
::/etc/hylafax/config.tty*
::Permission So That Faxstat Lists Received Faxes
<pre style="font-size: 130%; margin: 1em 2em 1em 2em;">
RecvFileMode:  0644
</pre>


<br>
<br>
==Hylafax Commands==
==Hylafax Commands==
===faxaddmodem===
*[http://www.hylafax.org/content/Handbook:Basic_Server_Configuration:Faxaddmodem Hylafax Documnetation - Faxaddmodem]
<pre style="font-size: 130%; margin: 1em 2em 1em 2em;">
sudo faxaddmodem
</pre>
*USB modem is usually at:  ttyACM0.
*Location of Config File
:<tt style="font-size: 130%">/etc/hylafax/config.tty[XXX]</tt>
<pre style="font-size: 130%; margin: 1em 2em 1em 2em;">
sudo nano config.ttyACM0
</pre>
*[[Hylafax - Sample Modem Config File|Sample Modem Config File]]
<br>
<br>
===Faxstat===
===Faxstat===
====Show Send Queue====
*[http://manpages.ubuntu.com/manpages/hardy/man1/faxstat.1.html Faxstat Man Page]
faxstat -s
=====Show Send Queue=====
<pre style="font-size: 130%; margin: 1em 2em 1em 2em;">
faxstat -s
</pre>
 
=====Options=====
{| style="margin: 0 2em 0 2em;"
|-
| width="50" | <tt style="font-size: 120%">-s</tt>
| width="500" | Show Send Queue.
|-
| <tt style="font-size: 120%">-d</tt>
| Show status of all jobs that have completed (done queue).  Format defined by JobFmt string in hyla.conf.
|-
| <tt style="font-size: 120%">-f</tt>
| Show status of document files in docq directory.  Format defined by FileFmt string in hyla.conf.
|-
| <tt style="font-size: 120%">-r</tt>
| Show Received Queue.
|-
| <tt style="font-size: 120%">-i</tt>
| Show Hylafax info.
|}
 
 
<br>
<br>
====Show Done Queue====
faxstat -d


===Sendfax===
===Sendfax===
====Send A Fax====
<pre style="font-size: 130%; margin: 1em 2em 1em 2em;">
sendfax -n [TELEPHONE NUMBER]
sendfax -n -d [TELEPHONE NUMBER] /usr/share/doc/hylafax-server/copyright
</pre>
 
{| style="margin: 0 2em 0 2em;"
|-
| width="200" | <tt style="font-size: 120%">-d [TELEPHONE NUMBER]</tt>
| width="400" | Destination.  To Telephone Number.
|-
| <tt style="font-size: 120%">-d [USER@TELEPHONE NUMBER]</tt>
| Destination.  From User, To Telephone Number.
|-
| <tt style="font-size: 120%">-f "[NAME OF FAX SENDER]"</tt>
| From.  If not used, the from line shows the default host.
|-
| <tt style="font-size: 120%">-n</tt>
| Suppress cover page.
|}
 
 
<br>
 
===Faxrm===
<pre style="font-size: 130%; margin: 1em 2em 1em 2em;">
faxrm [JOB ID]
</pre>
 
<br>
 
==Hylafax Directories==
 
{| style="margin: 0 2em 0 2em;"
|-
| width="250" | <tt style="font-size: 120%">/etc/hylafax</tt>
| width="400" | Config Files.
|-
| width="250" | <tt style="font-size: 120%">/etc/hylafax/hfaxd.conf</tt>
| width="400" |
|-
| width="250" | <tt style="font-size: 120%">/etc/hylafax/hyla.conf</tt>
| width="400" | Main Hylafax Config File.
|-
| width="250" | <tt style="font-size: 120%">/etc/hylafax/sendfax.conf</tt>
| width="400" |
|-
| width="250" | <tt style="font-size: 120%">/etc/hylafax/config.tty[XXX]</tt>
| width="400" | Fax Modem Settings.
|-
| <tt style="font-size: 120%">/var/spool/hylafax</tt>
| Spool Folder.
|-
| <tt style="font-size: 120%">/var/spool/hylafax/doneq</tt>
| FAX Jobs - Done.  [[Hylafax - doneq - Sample File|Sample doneq file.]]
|-
| <tt style="font-size: 120%">/var/spool/hylafax/docq</tt>
| Documents - Image Files/PDFs of Documents Sent & Received.
|-
| <tt style="font-size: 120%">/var/spool/hylafax/sendq</tt>
| FAX Jobs - To Be Sent.
|} 
 
 
<br>
 
==AvantFAX==
*[http://www.avantfax.com Website]
 
*Install AvantFAX on Ubuntu
<pre style="font-size: 130%; margin: 0 2em 0 2em;">
cd ~/Downloads
wget "https://downloads.sourceforge.net/project/avantfax/avantfax-3.3.3.tgz?r=&ts=1401631264&use_mirror=softlayer-dal"
gunzip avantfax-3.3.3.tgz
nano avantfax-3.3.3/debian-prefs.txt
sudo bash avantfax-3.3.3/debian-install.sh
</pre>


===faxrm===
<br>
faxrm [JOB ID]

Latest revision as of 16:09, 9 June 2014

General

(All examples in this section are using Linux/Ubuntu.)


Wiki Notes:


Install Hylafax

sudo apt-get install hylafax-server hylafax-client
sudo gpasswd -a [USERNAME] dialout
sudo chmod a+x /usr/sbin/pppd



Start and Stop Hylafax

sudo /etc/init.d/hylafax stop
sudo /etc/init.d/hylafax start


Configuration

  • General Configuration
/etc/hylafax/hfaxd.conf
Unrestrict Faxes So Other Users Can Access Them
JobProtection:   0644
PublicJobQ:       true
PublicRecvQ:     true


  • Modem Configuration
/etc/hylafax/config.tty*
Permission So That Faxstat Lists Received Faxes
RecvFileMode:   0644


Hylafax Commands

faxaddmodem

sudo faxaddmodem
  • USB modem is usually at: ttyACM0.
  • Location of Config File
/etc/hylafax/config.tty[XXX]
sudo nano config.ttyACM0




Faxstat

Show Send Queue
faxstat -s
Options
-s Show Send Queue.
-d Show status of all jobs that have completed (done queue). Format defined by JobFmt string in hyla.conf.
-f Show status of document files in docq directory. Format defined by FileFmt string in hyla.conf.
-r Show Received Queue.
-i Show Hylafax info.



Sendfax

 sendfax -n -d [TELEPHONE NUMBER] /usr/share/doc/hylafax-server/copyright
-d [TELEPHONE NUMBER] Destination. To Telephone Number.
-d [USER@TELEPHONE NUMBER] Destination. From User, To Telephone Number.
-f "[NAME OF FAX SENDER]" From. If not used, the from line shows the default host.
-n Suppress cover page.



Faxrm

faxrm [JOB ID]


Hylafax Directories

/etc/hylafax Config Files.
/etc/hylafax/hfaxd.conf
/etc/hylafax/hyla.conf Main Hylafax Config File.
/etc/hylafax/sendfax.conf
/etc/hylafax/config.tty[XXX] Fax Modem Settings.
/var/spool/hylafax Spool Folder.
/var/spool/hylafax/doneq FAX Jobs - Done. Sample doneq file.
/var/spool/hylafax/docq Documents - Image Files/PDFs of Documents Sent & Received.
/var/spool/hylafax/sendq FAX Jobs - To Be Sent.



AvantFAX

  • Install AvantFAX on Ubuntu
cd ~/Downloads
wget "https://downloads.sourceforge.net/project/avantfax/avantfax-3.3.3.tgz?r=&ts=1401631264&use_mirror=softlayer-dal"
gunzip avantfax-3.3.3.tgz
nano avantfax-3.3.3/debian-prefs.txt
sudo bash avantfax-3.3.3/debian-install.sh


Retrieved from "https://www.open-emr.org/wiki/index.php?title=Hylafax_Notes&oldid=17631"