File Locations
+ This need significant update
General
Most directories do not have files which are user editable on the system. The files which are not user maintained are maintained on GitHub
The directories which has files which the user can maintain are:
| /home/reuben | |
| /home/reuben/linuxcnc/configs/RoseEngineButlerLocal/REB_Axes | |
| /home/reuben/linuxcnc/configs/RoseEngineButlerLocal/REB_Custom | |
| /home/reuben/linuxcnc/nc_files |
Rose Engine Butler Structure on LinuxCNC
|
This is a directory with files which are not typically user-edited. |
/home/reuben
This directory gets created when LinuxCNC is installed. The files are put here by the REB_Install.sh Bash script.
Key files relative to LinuxCNC are:
| File | Purpose | User Editable | |
| .axisrc | Used to define the way the AXIS GUI displays when LinuxCNC starts. Note that the first character in file’s name is a dot, thusly, this is a hidden file. | Not recommended, but any of the text editing programs (e.g., Geany) could be used. | |
| REB_Backup.sh | This is a Bash script used by the user to backup their system's configuration. | Not recommended, but any of the text editing programs (e.g., Geany) could be used. | |
| REB_Restore.sh | This is a Bash script used by the user to restore their system's configuration. | Not recommended, but any of the text editing programs (e.g., Geany) could be used. | |
| REB_Update.sh | This is a Bash script used by the user to update their system's configuration. It performs:
| Not recommended, but any of the text editing programs (e.g., Geany) could be used. | |
|
This is not a directory with user-editable files. |
/home/reuben/linuxcnc/configs
This directory gets created when LinuxCNC is installed. There are no key files here.
|
This is not a directory with user-editable files. |
/home/reuben/linuxcnc/configs/RoseEngineButler
This directory gets created by GitHub when the Rose Engine Butler configurations are installed. Key files relative to LinuxCNC are:
| File | Purpose | User Editable | |
| REB.hal | This file outlines the hardware abstraction layer (HAL) used by LinuxCNC. | Not recommended, but any of the text editing programs (e.g., Geany) could be used. | |
| REB.ini | This file outlines the configuration settings for the Rose Engine Butler configuration. | Not recommended, but any of the text editing programs (e.g., Geany) could be used. | |
| REBStartupImage.gif | This is the image displayed before the full LinuxCNC system is displayed. | Not recommended, but a graphics program like GIMP could be used. | |
|
This is not a directory with user-editable files. |
/home/reuben/linuxcnc/configs/RoseEngineButler/REB_Axes
This directory gets created by GitHub when the Rose Engine Butler configurations are installed. The contents of this directory are not used by LinuxCNC per se; rather, during installation, these are the master copies which are copied to
| home/cnc/linuxcnc/configs/RoseEngineButlerLocal/REB_Axes |
and that directory's files get used when LinuxCNC is run.
Key files relative to LinuxCNC are:
| File | Purpose | User Editable | |
| REB_AxisB.inc | This is an incude file which gets incorporated with REB.ini when LinuxCNC starts. It defines the axis settings for the B axis. | No. Editing this file will cause the Git pull process to fail. | |
| REB_AxisU.inc | This is an incude file which gets incorporated with REB.ini when LinuxCNC starts. It defines the axis settings for the U axis. | No. Editing this file will cause the Git pull process to fail. | |
| REB_AxisV.inc | This is an incude file which gets incorporated with REB.ini when LinuxCNC starts. It defines the axis settings for the V axis. | No. Editing this file will cause the Git pull process to fail. | |
| REB_AxisW.inc | This is an incude file which gets incorporated with REB.ini when LinuxCNC starts. It defines the axis settings for the W axis. | No. Editing this file will cause the Git pull process to fail. | |
| REB_AxisX.inc | This is an incude file which gets incorporated with REB.ini when LinuxCNC starts. It defines the axis settings for the X axis. | No. Editing this file will cause the Git pull process to fail. | |
| REB_AxisZ.inc | This is an incude file which gets incorporated with REB.ini when LinuxCNC starts. It defines the axis settings for the Z axis. | No. Editing this file will cause the Git pull process to fail. | |
| REB_Spindle0.inc | This is an incude file which gets incorporated with REB.ini when LinuxCNC starts. It defines the axis settings for the spindle. | No. Editing this file will cause the Git pull process to fail. | |
| REB_Spindle1.inc | This is an incude file which gets incorporated with REB.ini when LinuxCNC starts. It defines the axis settings for the rosette phaser/multiplier. | No. Editing this file will cause the Git pull process to fail. | |
|
This is not a directory with user-editable files. |
/home/reuben/linuxcnc/configs/RoseEngineButler/REB_Custom
This directory gets created by GitHub when the Rose Engine Butler configurations are installed. The contents of this directory are not used by LinuxCNC per se; rather, during installation, these are the master copies which are copied to
| /home/reuben/linuxcnc/configs/RoseEngineButlerLocal/REB_Custom |
and that directory's files get used when LinuxCNC is run.
Key files relative to LinuxCNC are:
| File | Purpose | User Editable | |
| REB_Custom.hal | Will be used by the user for whatever customized configuration is desired. The idea is to have the user not modify the REB.HAL mistakenly. | No. Editing this file will cause the Git pull process to fail. | |
| REB_Shutdown.hal | Will be used by the user for whatever customized configuration is desired. | No. Editing this file will cause the Git pull process to fail. | |
| REB_Tool.tbl | Will be used by the user for whatever customized configuration is desired. | No. Editing this file will cause the Git pull process to fail.
| |
|
This is not a directory with user-editable files. |
/home/reuben/linuxcnc/configs/RoseEngineButler/REB_Display
This directory gets created by GitHub when the Rose Engine Butler configurations are installed. Key files relative to LinuxCNC are:
| File | Purpose | User Editable | |
| hitconter.py | This python program handles the commands needed for the buttons pressed by the user using the Glade panels (the .ui files). This interface is used where the activities are more complex and python scripts are needed to program them (i.e., for handling entered on data entry fields by users of the system) | No. Editing this file will cause the Git pull process to fail. | |
| REB_Panel_vX.ui | The panel displayed to the right. | No. Editing this file will cause the Git pull process to fail. | |
| REB_PostGUI.hal | This hal file is used to define the pins needed for the Glade displays. It is used where the interactions with core LinuxCNC are simple (e.g., with signals):
| ||
| REB_Tab_Help_vX.ui | The tab for the user which outlines where to get help. This should be the second from the right-most tab in the display. | No. Editing this file will cause the Git pull process to fail. | |
| REB_Tab_TsCs_vX.ui | The tab for the user which outlines the terms and conditions for use of Rose Engine Butler.. This should be the right-most tab in the display. | No. Editing this file will cause the Git pull process to fail.
| |
|
This is not a directory with user-editable files. |
/home/reuben/linuxcnc/configs/RoseEngineButler/REB_Display/Images
This directory gets created by GitHub when the Rose Engine Butler configurations are installed.
|
This is not a directory with user-editable files. |
/home/reuben/linuxcnc/configs/REB_Setup
This directory gets created by GitHub when the Rose Engine Butler configurations are installed. Key files relative to LinuxCNC are:
| File | Purpose | User Editable | |
| axisrc | This file gets copied into /home/reuben where it will be used. There is no "." as the 1st character in the file name. This is because that would fail with GitHub. The "." is added by the REB_Install.sh Bash script. | No. Editing this file will cause the Git pull process to fail. | |
| lightdm.conf | Used for the initial installation of the system. | No. Editing this file will cause the Git pull process to fail. | |
| REB_Backup.sh | This file gets copied into /home/reuben where it will be used. | No. Editing this file will cause the Git pull process to fail. | |
| REB_Install.sh | Used for the initial installation of the system; puts files where they need to go. | No. Editing this file will cause the Git pull process to fail. | |
| REB_Restore.sh | This file gets copied into /home/reuben where it will be used. | No. Editing this file will cause the Git pull process to fail. | |
| REB_Update.sh | This file gets copied into /home/reuben where it will be used. | No. Editing this file will cause the Git pull process to fail. | |
|
This is not a directory with user-editable files. |
/home/reuben/linuxcnc/configs/REB_Setup/Images
This directory gets created by GitHub when the Rose Engine Butler configurations are installed. Key files relative to LinuxCNC are:
| File | Purpose | User Editable | |
| REBStartupImage.gif | Displayed when LinuxCNC starts up before the main panel is displayed. | No. Editing this file will cause the Git pull process to fail. | |
| REBWallpaper.png | Desktop wallpaper for Debian. | No. Editing this file will cause the Git pull process to fail. | |
| Reuben.gif | Reuben logo image. | No. Editing this file will cause the Git pull process to fail. | |
| Reuben.png | Reuben logo image. | No. Editing this file will cause the Git pull process to fail. | |
| ReubenHead.png | Reuben's head. Used as the icon for the application launcher. | No. Editing this file will cause the Git pull process to fail. | |
|
This is not a directory with user-editable files. |
/home/reuben/linuxcnc/configs/REB_Setup/MesaCard
This directory gets created by GitHub when the Rose Engine Butler configurations are installed. Key files relative to LinuxCNC are:
| File | Purpose | User Editable | |
| 7i92t_REB.bin | Used to setup the Mesa card. | No. Editing this file will cause the Git pull process to fail. | |
| 7i92t_REB.pin | Used to setup the Mesa card. | No. Editing this file will cause the Git pull process to fail. | |
| PIN_REB_34.vhd | Used to setup the Mesa card. | No. Editing this file will cause the Git pull process to fail. | |
|
This is the directory with user-editable files. |
/home/reuben/linuxcnc/configs/RoseEngineButlerLocal/REB_Axes
This directory gets created by the Bash file, Install.sh (in /home/reuben/linuxcnc/configs/RoseEngineButler/REB_Setup), when the Rose Engine Butler configurations are installed.
The files in this directory were copied from:
| /home/reuben/linuxcnc/configs/RoseEngineButler/REB_Axes |
These files can be edited using any of the text editing programs (e.g., Geany).
|
This is the directory with user-editable files. |
/home/reuben/linuxcnc/configs/RoseEngineButlerLocal/REB_Custom
This directory gets created by the Bash file, Install.sh (in /home/reuben/linuxcnc/configs/RoseEngineButler/REB_Setup), when the Rose Engine Butler configurations are installed.
The files in this directory were copied from:
| /home/reuben/linuxcnc/configs/RoseEngineButler/REB_Custom |
These files can be edited using any of the text editing programs (e.g., Geany).
|
This is the directory with user-editable files. |
/home/reuben/linuxcnc/nc_files
This directory gets created when LinuxCNC is installed. This is where users will store any Gcode program files.
|
eMail comments to |