Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

script: add page #2485

Merged
merged 6 commits into from
Oct 28, 2018
Merged

script: add page #2485

merged 6 commits into from
Oct 28, 2018

Conversation

BenNF
Copy link
Contributor

@BenNF BenNF commented Oct 23, 2018

I created a page for the unix command script that records the terminal.

  • [x ] The page (if new), does not already exist in the repo.

  • [ x] The page (if new), has been added to the correct platform folder:
    common/ if it's common to all platforms, linux/ if it's Linux-specific, and so on.

  • [ x] The page has 8 or fewer examples.

  • [ x] The PR is appropriately titled:
    <command name>: add page for new pages, or <command name>: <description of changes> for pages being edited.

  • [ x] The page follows the contributing guidelines.

@tldr-bot
Copy link

The build for this PR has failed with the following error(s):

pages/common/script.md:9: TLDR005 Example descriptions should end in a colon
pages/common/script.md:20: TLDR008 File should contain no trailing whitespace

Please fix the error(s) and push again.

@owenvoke owenvoke added the new command Issues requesting creation of a new page. label Oct 24, 2018
Copy link
Member

@agnivade agnivade left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please also use tokens ({{}}) for logfile.log.

@@ -0,0 +1,19 @@
# script

> Make typescript of terminal session.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

"Make a typescript file of a terminal session" sounds clearer


> Make typescript of terminal session.

- Start recording in new file:
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We should start with the simplest option first - script. And mention that without any arguments it saves in a file named "typescript"


- Append to an existing log file:

`command -a logfile.log`
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

script instead of command.


`command -a logfile.log`

- Record without start and done messages (quiet):
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

How about - "Execute quietly without start and done messages"

@tldr-bot
Copy link

The build for this PR has failed with the following error(s):

pages/common/script.md:3: TLDR004 Command descriptions should end in a period

Please fix the error(s) and push again.

@tldr-bot
Copy link

The build for this PR has failed with the following error(s):

pages/common/script.md:3: TLDR004 Command descriptions should end in a period
pages/common/script.md:22: TLDR103 Command example is missing its closing backtick

Please fix the error(s) and push again.

BenNF and others added 2 commits October 24, 2018 17:20
- Changed file to logfile.log to be consistent.
- Removed "log" from description as it is redundant.
Copy link
Member

@agnivade agnivade left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Made some slight changes. Hope that's okay.

@agnivade agnivade mentioned this pull request Oct 27, 2018
5 tasks
@sbrl sbrl merged commit e72e020 into tldr-pages:master Oct 28, 2018
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
new command Issues requesting creation of a new page.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

5 participants