Menu
▾
▴
[Emc-commit] v2.5_branch: Docs: markup fixes
|
From: John T. <gi...@gi...> - 2011-12-13 13:10:20
|
Docs: markup fixes Signed-off-by: John Thornton <jth...@gn...> http://git.linuxcnc.org/?p=emc2.git;a=commitdiff;h=55aed79 --- docs/src/common/Linux_FAQ.txt | 89 +++++++++++++++++++++++++-------- docs/src/common/Linux_FAQ_de.txt | 93 +++++++++++++++++++++++++--------- docs/src/common/Linux_FAQ_es.txt | 93 +++++++++++++++++++++++++--------- docs/src/common/Linux_FAQ_pl.txt | 89 +++++++++++++++++++++++++-------- docs/src/config/copy_and_run.txt | 5 ++- docs/src/config/copy_and_run_de.txt | 7 ++- docs/src/config/copy_and_run_es.txt | 7 ++- docs/src/config/copy_and_run_pl.txt | 7 ++- 8 files changed, 289 insertions(+), 101 deletions(-) diff --git a/docs/src/common/Linux_FAQ.txt b/docs/src/common/Linux_FAQ.txt index d2ba2e0..42fbf75 100644 --- a/docs/src/common/Linux_FAQ.txt +++ b/docs/src/common/Linux_FAQ.txt @@ -1,3 +1,6 @@ +:lang: en +:toc: + = Linux FAQ (((Linux FAQ))) These are some basic Linux commands and techniques for new to Linux @@ -24,7 +27,9 @@ file. Example: - emc /home/mill/emc2/config/mill/mill.ini +---- +emc /home/mill/emc2/config/mill/mill.ini +---- == Man Pages[[sec:Man-Pages]] @@ -37,7 +42,9 @@ To view a man page open up a terminal window by going to Applications, Accessories, Terminal. For example if you wanted to find out something about the find command in the terminal window type: - man find +---- +man find +---- Use the Page Up and Page Down keys to view the man page and the Q key to quit viewing. @@ -47,12 +54,16 @@ to quit viewing. Sometimes when troubleshooting you need to get a list of modules that are loaded. In a terminal window type: - lsmod +---- +lsmod +---- If you want to send the output from lsmod to a text file in a terminal window type: - lsmod > mymod.txt +---- +lsmod > mymod.txt +---- The resulting text file will be located in the home directory if you did not change directories when you opened up the terminal window and @@ -76,7 +87,9 @@ Open up Applications, Accessories, Terminal. In the terminal window type - sudo gedit +---- +sudo gedit +---- Open the file with File, Open then edit @@ -86,7 +99,7 @@ Open the file with File, Open then edit . Right click on the desktop and select Create Launcher . Type a name in like sudo edit - . Type `gksudo "gnome-open %u"` as the command and save the launcher to + . Type 'gksudo "gnome-open %u"' as the command and save the launcher to your desktop . Drag a file onto your launcher to open and edit @@ -105,7 +118,9 @@ foul things up as root if you don't know what you're doing. To find out the path to the present working directory in the terminal window type: - pwd +---- +pwd +---- === Changing Directories @@ -113,16 +128,22 @@ window type: To move up one level in the terminal window type: - cd .. +---- +cd .. +---- To move up two levels in the terminal window type: - cd ../.. +---- +cd ../.. +---- To move down to the emc2/configs subdirectory in the terminal window type: - cd emc2/configs +---- +cd emc2/configs +---- === Listing files in a directory @@ -130,11 +151,15 @@ type: To view a list of all the files and subdirectories in the terminal window type: - dir +---- +dir +---- or - ls +---- +ls +---- === Finding a File @@ -143,21 +168,29 @@ or The find command can be a bit confusing to a new Linux user. The basic syntax is: - find starting-directory parameters actions +---- +find starting-directory parameters actions +---- For example to find all the .ini files in your emc2 directory you first need to use the pwd command to find out the directory. + Open a new terminal window and type: - pwd +---- +pwd +---- And pwd might return the following result: - /home/joe +---- +/home/joe +---- With this information put the command together like this: - find /home/joe/emc2 -name *.ini -print +---- +find /home/joe/emc2 -name *.ini -print +---- The -name is the name of the file your looking for and the -print tells it to print out the result to the terminal window. + @@ -167,13 +200,17 @@ To find all the files in the named directory and all the subdirectories under that, add the -L option to the find command, like this: - find -L /home/joe/emc2 -name *.ini -print +---- +find -L /home/joe/emc2 -name *.ini -print +---- === Searching for Text (((Searching for Text)))(((grep))) - grep -i -r 'text to search for' * +---- +grep -i -r 'text to search for' * +---- This will find all the files that contain the 'text to search for' in the current directory and all the subdirectories below it, while @@ -187,14 +224,18 @@ To view the bootup messages use "dmesg" from the command window. To save the bootup messages to a file use the redirection operator, like this: - dmesg > bootmsg.txt +---- +dmesg > bootmsg.txt +---- The contents of this file can be copied and pasted on line to share with people trying to help you diagnose your problem. To clear the message buffer type this: - sudo dmesg -c +---- +sudo dmesg -c +---- This can be helpful to do just before launching EMC, so that there will only be a record of information related to the current launch of EMC. @@ -204,7 +245,9 @@ out of dmesg. After boot up open a terminal and type: - dmesg|grep parport +---- +dmesg|grep parport +---- == Convenience Items @@ -222,7 +265,9 @@ and Add. Give it a name and put gnome-terminal in the command box. To find out what hardware is connected to your motherboard in a terminal window type: - lspci -v +---- +lspci -v +---- === Monitor Resolution diff --git a/docs/src/common/Linux_FAQ_de.txt b/docs/src/common/Linux_FAQ_de.txt index 49a9217..42fbf75 100644 --- a/docs/src/common/Linux_FAQ_de.txt +++ b/docs/src/common/Linux_FAQ_de.txt @@ -1,3 +1,6 @@ +:lang: en +:toc: + = Linux FAQ (((Linux FAQ))) These are some basic Linux commands and techniques for new to Linux @@ -24,7 +27,9 @@ file. Example: - emc /home/mill/emc2/config/mill/mill.ini +---- +emc /home/mill/emc2/config/mill/mill.ini +---- == Man Pages[[sec:Man-Pages]] @@ -37,7 +42,9 @@ To view a man page open up a terminal window by going to Applications, Accessories, Terminal. For example if you wanted to find out something about the find command in the terminal window type: - man find +---- +man find +---- Use the Page Up and Page Down keys to view the man page and the Q key to quit viewing. @@ -47,12 +54,16 @@ to quit viewing. Sometimes when troubleshooting you need to get a list of modules that are loaded. In a terminal window type: - lsmod +---- +lsmod +---- If you want to send the output from lsmod to a text file in a terminal window type: - lsmod > mymod.txt +---- +lsmod > mymod.txt +---- The resulting text file will be located in the home directory if you did not change directories when you opened up the terminal window and @@ -76,7 +87,9 @@ Open up Applications, Accessories, Terminal. In the terminal window type - sudo gedit +---- +sudo gedit +---- Open the file with File, Open then edit @@ -86,7 +99,7 @@ Open the file with File, Open then edit . Right click on the desktop and select Create Launcher . Type a name in like sudo edit - . Type `gksudo "gnome-open %u"` as the command and save the launcher to + . Type 'gksudo "gnome-open %u"' as the command and save the launcher to your desktop . Drag a file onto your launcher to open and edit @@ -100,14 +113,14 @@ foul things up as root if you don't know what you're doing. (((Terminal Commands))) -=== Working Directory - -(((Working Directory)))(((pwd))) +=== Working Directory (((Working Directory)))(((pwd))) To find out the path to the present working directory in the terminal window type: - pwd +---- +pwd +---- === Changing Directories @@ -115,16 +128,22 @@ window type: To move up one level in the terminal window type: - cd .. +---- +cd .. +---- To move up two levels in the terminal window type: - cd ../.. +---- +cd ../.. +---- To move down to the emc2/configs subdirectory in the terminal window type: - cd emc2/configs +---- +cd emc2/configs +---- === Listing files in a directory @@ -132,11 +151,15 @@ type: To view a list of all the files and subdirectories in the terminal window type: - dir +---- +dir +---- or - ls +---- +ls +---- === Finding a File @@ -145,21 +168,29 @@ or The find command can be a bit confusing to a new Linux user. The basic syntax is: - find starting-directory parameters actions +---- +find starting-directory parameters actions +---- For example to find all the .ini files in your emc2 directory you first need to use the pwd command to find out the directory. + Open a new terminal window and type: - pwd +---- +pwd +---- And pwd might return the following result: - /home/joe +---- +/home/joe +---- With this information put the command together like this: - find /home/joe/emc2 -name *.ini -print +---- +find /home/joe/emc2 -name *.ini -print +---- The -name is the name of the file your looking for and the -print tells it to print out the result to the terminal window. + @@ -169,13 +200,17 @@ To find all the files in the named directory and all the subdirectories under that, add the -L option to the find command, like this: - find -L /home/joe/emc2 -name *.ini -print +---- +find -L /home/joe/emc2 -name *.ini -print +---- === Searching for Text (((Searching for Text)))(((grep))) - grep -i -r 'text to search for' * +---- +grep -i -r 'text to search for' * +---- This will find all the files that contain the 'text to search for' in the current directory and all the subdirectories below it, while @@ -189,14 +224,18 @@ To view the bootup messages use "dmesg" from the command window. To save the bootup messages to a file use the redirection operator, like this: - dmesg > bootmsg.txt +---- +dmesg > bootmsg.txt +---- The contents of this file can be copied and pasted on line to share with people trying to help you diagnose your problem. To clear the message buffer type this: - sudo dmesg -c +---- +sudo dmesg -c +---- This can be helpful to do just before launching EMC, so that there will only be a record of information related to the current launch of EMC. @@ -206,7 +245,9 @@ out of dmesg. After boot up open a terminal and type: - dmesg|grep parport +---- +dmesg|grep parport +---- == Convenience Items @@ -224,7 +265,9 @@ and Add. Give it a name and put gnome-terminal in the command box. To find out what hardware is connected to your motherboard in a terminal window type: - lspci -v +---- +lspci -v +---- === Monitor Resolution diff --git a/docs/src/common/Linux_FAQ_es.txt b/docs/src/common/Linux_FAQ_es.txt index 49a9217..42fbf75 100644 --- a/docs/src/common/Linux_FAQ_es.txt +++ b/docs/src/common/Linux_FAQ_es.txt @@ -1,3 +1,6 @@ +:lang: en +:toc: + = Linux FAQ (((Linux FAQ))) These are some basic Linux commands and techniques for new to Linux @@ -24,7 +27,9 @@ file. Example: - emc /home/mill/emc2/config/mill/mill.ini +---- +emc /home/mill/emc2/config/mill/mill.ini +---- == Man Pages[[sec:Man-Pages]] @@ -37,7 +42,9 @@ To view a man page open up a terminal window by going to Applications, Accessories, Terminal. For example if you wanted to find out something about the find command in the terminal window type: - man find +---- +man find +---- Use the Page Up and Page Down keys to view the man page and the Q key to quit viewing. @@ -47,12 +54,16 @@ to quit viewing. Sometimes when troubleshooting you need to get a list of modules that are loaded. In a terminal window type: - lsmod +---- +lsmod +---- If you want to send the output from lsmod to a text file in a terminal window type: - lsmod > mymod.txt +---- +lsmod > mymod.txt +---- The resulting text file will be located in the home directory if you did not change directories when you opened up the terminal window and @@ -76,7 +87,9 @@ Open up Applications, Accessories, Terminal. In the terminal window type - sudo gedit +---- +sudo gedit +---- Open the file with File, Open then edit @@ -86,7 +99,7 @@ Open the file with File, Open then edit . Right click on the desktop and select Create Launcher . Type a name in like sudo edit - . Type `gksudo "gnome-open %u"` as the command and save the launcher to + . Type 'gksudo "gnome-open %u"' as the command and save the launcher to your desktop . Drag a file onto your launcher to open and edit @@ -100,14 +113,14 @@ foul things up as root if you don't know what you're doing. (((Terminal Commands))) -=== Working Directory - -(((Working Directory)))(((pwd))) +=== Working Directory (((Working Directory)))(((pwd))) To find out the path to the present working directory in the terminal window type: - pwd +---- +pwd +---- === Changing Directories @@ -115,16 +128,22 @@ window type: To move up one level in the terminal window type: - cd .. +---- +cd .. +---- To move up two levels in the terminal window type: - cd ../.. +---- +cd ../.. +---- To move down to the emc2/configs subdirectory in the terminal window type: - cd emc2/configs +---- +cd emc2/configs +---- === Listing files in a directory @@ -132,11 +151,15 @@ type: To view a list of all the files and subdirectories in the terminal window type: - dir +---- +dir +---- or - ls +---- +ls +---- === Finding a File @@ -145,21 +168,29 @@ or The find command can be a bit confusing to a new Linux user. The basic syntax is: - find starting-directory parameters actions +---- +find starting-directory parameters actions +---- For example to find all the .ini files in your emc2 directory you first need to use the pwd command to find out the directory. + Open a new terminal window and type: - pwd +---- +pwd +---- And pwd might return the following result: - /home/joe +---- +/home/joe +---- With this information put the command together like this: - find /home/joe/emc2 -name *.ini -print +---- +find /home/joe/emc2 -name *.ini -print +---- The -name is the name of the file your looking for and the -print tells it to print out the result to the terminal window. + @@ -169,13 +200,17 @@ To find all the files in the named directory and all the subdirectories under that, add the -L option to the find command, like this: - find -L /home/joe/emc2 -name *.ini -print +---- +find -L /home/joe/emc2 -name *.ini -print +---- === Searching for Text (((Searching for Text)))(((grep))) - grep -i -r 'text to search for' * +---- +grep -i -r 'text to search for' * +---- This will find all the files that contain the 'text to search for' in the current directory and all the subdirectories below it, while @@ -189,14 +224,18 @@ To view the bootup messages use "dmesg" from the command window. To save the bootup messages to a file use the redirection operator, like this: - dmesg > bootmsg.txt +---- +dmesg > bootmsg.txt +---- The contents of this file can be copied and pasted on line to share with people trying to help you diagnose your problem. To clear the message buffer type this: - sudo dmesg -c +---- +sudo dmesg -c +---- This can be helpful to do just before launching EMC, so that there will only be a record of information related to the current launch of EMC. @@ -206,7 +245,9 @@ out of dmesg. After boot up open a terminal and type: - dmesg|grep parport +---- +dmesg|grep parport +---- == Convenience Items @@ -224,7 +265,9 @@ and Add. Give it a name and put gnome-terminal in the command box. To find out what hardware is connected to your motherboard in a terminal window type: - lspci -v +---- +lspci -v +---- === Monitor Resolution diff --git a/docs/src/common/Linux_FAQ_pl.txt b/docs/src/common/Linux_FAQ_pl.txt index d2ba2e0..42fbf75 100644 --- a/docs/src/common/Linux_FAQ_pl.txt +++ b/docs/src/common/Linux_FAQ_pl.txt @@ -1,3 +1,6 @@ +:lang: en +:toc: + = Linux FAQ (((Linux FAQ))) These are some basic Linux commands and techniques for new to Linux @@ -24,7 +27,9 @@ file. Example: - emc /home/mill/emc2/config/mill/mill.ini +---- +emc /home/mill/emc2/config/mill/mill.ini +---- == Man Pages[[sec:Man-Pages]] @@ -37,7 +42,9 @@ To view a man page open up a terminal window by going to Applications, Accessories, Terminal. For example if you wanted to find out something about the find command in the terminal window type: - man find +---- +man find +---- Use the Page Up and Page Down keys to view the man page and the Q key to quit viewing. @@ -47,12 +54,16 @@ to quit viewing. Sometimes when troubleshooting you need to get a list of modules that are loaded. In a terminal window type: - lsmod +---- +lsmod +---- If you want to send the output from lsmod to a text file in a terminal window type: - lsmod > mymod.txt +---- +lsmod > mymod.txt +---- The resulting text file will be located in the home directory if you did not change directories when you opened up the terminal window and @@ -76,7 +87,9 @@ Open up Applications, Accessories, Terminal. In the terminal window type - sudo gedit +---- +sudo gedit +---- Open the file with File, Open then edit @@ -86,7 +99,7 @@ Open the file with File, Open then edit . Right click on the desktop and select Create Launcher . Type a name in like sudo edit - . Type `gksudo "gnome-open %u"` as the command and save the launcher to + . Type 'gksudo "gnome-open %u"' as the command and save the launcher to your desktop . Drag a file onto your launcher to open and edit @@ -105,7 +118,9 @@ foul things up as root if you don't know what you're doing. To find out the path to the present working directory in the terminal window type: - pwd +---- +pwd +---- === Changing Directories @@ -113,16 +128,22 @@ window type: To move up one level in the terminal window type: - cd .. +---- +cd .. +---- To move up two levels in the terminal window type: - cd ../.. +---- +cd ../.. +---- To move down to the emc2/configs subdirectory in the terminal window type: - cd emc2/configs +---- +cd emc2/configs +---- === Listing files in a directory @@ -130,11 +151,15 @@ type: To view a list of all the files and subdirectories in the terminal window type: - dir +---- +dir +---- or - ls +---- +ls +---- === Finding a File @@ -143,21 +168,29 @@ or The find command can be a bit confusing to a new Linux user. The basic syntax is: - find starting-directory parameters actions +---- +find starting-directory parameters actions +---- For example to find all the .ini files in your emc2 directory you first need to use the pwd command to find out the directory. + Open a new terminal window and type: - pwd +---- +pwd +---- And pwd might return the following result: - /home/joe +---- +/home/joe +---- With this information put the command together like this: - find /home/joe/emc2 -name *.ini -print +---- +find /home/joe/emc2 -name *.ini -print +---- The -name is the name of the file your looking for and the -print tells it to print out the result to the terminal window. + @@ -167,13 +200,17 @@ To find all the files in the named directory and all the subdirectories under that, add the -L option to the find command, like this: - find -L /home/joe/emc2 -name *.ini -print +---- +find -L /home/joe/emc2 -name *.ini -print +---- === Searching for Text (((Searching for Text)))(((grep))) - grep -i -r 'text to search for' * +---- +grep -i -r 'text to search for' * +---- This will find all the files that contain the 'text to search for' in the current directory and all the subdirectories below it, while @@ -187,14 +224,18 @@ To view the bootup messages use "dmesg" from the command window. To save the bootup messages to a file use the redirection operator, like this: - dmesg > bootmsg.txt +---- +dmesg > bootmsg.txt +---- The contents of this file can be copied and pasted on line to share with people trying to help you diagnose your problem. To clear the message buffer type this: - sudo dmesg -c +---- +sudo dmesg -c +---- This can be helpful to do just before launching EMC, so that there will only be a record of information related to the current launch of EMC. @@ -204,7 +245,9 @@ out of dmesg. After boot up open a terminal and type: - dmesg|grep parport +---- +dmesg|grep parport +---- == Convenience Items @@ -222,7 +265,9 @@ and Add. Give it a name and put gnome-terminal in the command box. To find out what hardware is connected to your motherboard in a terminal window type: - lspci -v +---- +lspci -v +---- === Monitor Resolution diff --git a/docs/src/config/copy_and_run.txt b/docs/src/config/copy_and_run.txt index 43d9ea3..2843cf0 100644 --- a/docs/src/config/copy_and_run.txt +++ b/docs/src/config/copy_and_run.txt @@ -1,4 +1,7 @@ -= Running EMC2 +:lang: en +:toc: + += Running EMC2(((Running EMC2))) == Invoking EMC2 diff --git a/docs/src/config/copy_and_run_de.txt b/docs/src/config/copy_and_run_de.txt index 9ffffab..2843cf0 100644 --- a/docs/src/config/copy_and_run_de.txt +++ b/docs/src/config/copy_and_run_de.txt @@ -1,4 +1,7 @@ -= Running EMC2 +:lang: en +:toc: + += Running EMC2(((Running EMC2))) == Invoking EMC2 @@ -35,7 +38,7 @@ without showing the Configuration Selector screen. When you select a configuration from the Sample Configurations section, it will automaticly place a copy of that config in the -emc/configs directory. +emc/configs directory. == Next steps in configuration diff --git a/docs/src/config/copy_and_run_es.txt b/docs/src/config/copy_and_run_es.txt index 9ffffab..2843cf0 100644 --- a/docs/src/config/copy_and_run_es.txt +++ b/docs/src/config/copy_and_run_es.txt @@ -1,4 +1,7 @@ -= Running EMC2 +:lang: en +:toc: + += Running EMC2(((Running EMC2))) == Invoking EMC2 @@ -35,7 +38,7 @@ without showing the Configuration Selector screen. When you select a configuration from the Sample Configurations section, it will automaticly place a copy of that config in the -emc/configs directory. +emc/configs directory. == Next steps in configuration diff --git a/docs/src/config/copy_and_run_pl.txt b/docs/src/config/copy_and_run_pl.txt index 9ffffab..2843cf0 100644 --- a/docs/src/config/copy_and_run_pl.txt +++ b/docs/src/config/copy_and_run_pl.txt @@ -1,4 +1,7 @@ -= Running EMC2 +:lang: en +:toc: |